Cadcorp Web API
Cadcorp.GFB.CadcorpSP
GenericSP Class
GenericSP Methods
AddWfsOverlay Method
AddWmsOverlay Method
AttributeSelectionFromString Method
CentreOn Method
CreateFolderAndFilesForCurrentUser Method
CreateOverlayImage Method
DeleteItem Method
DescribeCurrentRoute Method
DrawGenericShape Method
DrawLine Method
DrawPoint Method
DrawPolygon Method
DrawScreenLine Method
DrawScreenPolygon Method
DrawText Method
EditItem Method
EvaluateSchemaColumn Method
ExportGToolsGeneralToBdsForCurrentUser Method
ExportItemsToCsv Method
ExportSelectedOverlay Method
FilterOverlay Method
FilterOverlaysByCategory Method
FilterOverlaysByIndex Method
FilterOverlaysByName Method
FilterOverlaysByScaleThreshold Method
FilterOverlaysBySingleIndex Method
FilterOverlaysBySingleName Method
FilterVectorOverlays Method
FindCurrentItemName Method
GenerateAllOverlayImages Method
GetAllAttributedItemsFromOverlay Method
GetAllItemsFromSpatialTestAndFormula Method
GetAllItemsFromSpatialTestAndFormulaWithCursorParameter Method
GetAllItemsFromSpatialTestAndFormulaWithRendersize Method
GetAngle Method
GetAttributedItems Method
GetAttributedItemsUsingOverlay Method
GetCompass Method
GetCurrentAttributedItem Method
GetCurrentItem Method
GetCurrentItemAttributes Method
GetCurrentItemFormulae Method
GetDirection Method
GetEditingData Method
GetEditingGeometry Method
GetItems Method
GetItemsForEditing Method
GetItemsForEditingFromAnnotationLayer Method
GetMap Method
GetMapScale Method
GetOverlayDetails Method
GetOverlayFeatureCodes Method
GetOverlayGroups Method
GetOverlayImage Method
GetOverlayImages Method
GetOverlayNumberFromName Method
GetOverlaySchema Method
GetOverlayStyles Method
GetOverlayThemes Method
GetProjectionName Method
GetRenderExtent Method
GetSingleOverlayDetails Method
GetSingleOverlayStyles Method
GetSortedItems Method
GetStandardUrlParameters Method
GetSwdExtent Method
GetThemeLegendSizes Method
GetViewAngle Method
GetWfsOverlays Method
GetWmsOverlays Method
IsCursorDataSet Method
OpenItem Method
OverlayIsPersistent Method
OverlayIsVector Method
PanByVector Method
PanHalfScreen Method
RepairStoredOverlayStatuses Method
ReplicateSelection Method
ReplicateSelectionWithoutBooleanOperation Method
RequiresSisFilter Method
RestoreOverlayStatuses Method
SafeGetViewPos Method
SetFeatureCodeStatus Method
SetRenderSize Method
SetStandardUrlParameters Method
SetThemeComponentStatus Method
SetThemeStatus Method
SisFilterToWhereClause Method
SisFilterToWhereClause1 Method
StoreOverlayStatuses Method
StrictlyOlderThan Method
WhereEnabled Method
Click or drag to resize

GenericSPGetSingleOverlayDetails Method

Generate a complete description of the current overlays, including feature coding and theming.

Namespace:  Cadcorp.GFB.CadcorpSP
Assembly:  Cadcorp.GFB.GenericStoredProcedures (in Cadcorp.GFB.GenericStoredProcedures.dll) Version: 9.0.2618.0 (9.0.2618.0)
Syntax
Copy
protected Overlay GetSingleOverlayDetails(
	int overlayNumber,
	bool includeThemes,
	bool includeFeatureCodes,
	bool includeSchema
)

Parameters

overlayNumber
Type: SystemInt32
The number of the overlay to get the details of
includeThemes
Type: SystemBoolean
If true, theme information is included.
includeFeatureCodes
Type: SystemBoolean
If true, feature coding information is included.
includeSchema
Type: SystemBoolean
If true, schema information is included.

Return Value

Type: Overlay
AnOverlay structures describing the overlay.
Remarks
Depending on the various parameters passed, certain sub-arrays may be unpopulated.
See Also