api:dk11:activex:tatukgis_xdk11.tgis_controllegend
Table of Contents
TGIS_ControlLegend class
DK for ActiveX | TatukGIS_XDK11.TGIS_ControlLegend | Classes | Methods | Properties
Visual Legend component.
Available also on: Delphi FMX | .NET WinForms | Java | Python.
Syntax
// C# public class TGIS_ControlLegend : ITGIS_ControlLegend, ITGIS_ControlLegend_OCX, IGIS_PrintableControl, ITGIS_ControlLegendEvents { }
' VisualBasic Public Class TGIS_ControlLegend Implements ITGIS_ControlLegend Implements ITGIS_ControlLegend_OCX Implements IGIS_PrintableControl Implements ITGIS_ControlLegendEvents End Class
// Oxygene type TGIS_ControlLegend = public class end;
Implements
Methods
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| AttachDelphiObj | public | Only for internal use of TatukGIS. (Inherited from ITBaseObject) (Implements ITBaseObject.AttachDelphiObj) |
|
| Collapse | public | Collapses a legend item corresponding to a hierarchy group. | |
| Collapse_2 | public | Collapses a legend item corresponding to a hierarchy group. | |
| Collapse_3 | public | Collapses a legend item corresponding to a layer. | |
| DelphiObj | public | Only for internal use of TatukGIS. (Inherited from ITBaseObject) (Implements ITBaseObject.DelphiObj) |
|
| DrawBmp | public | Draw control on a provided bitmap. | |
| Expand | public | Expands of a legend item associated with the specific hierarchy group. | |
| Expand_2 | public | Expands a legend item corresponding to a hierarchy group. | |
| Expand_3 | public | Expands a legend item associated with the specific layer. | |
| GetNodeAt | public | Retrieves the node at a given position. | |
| GroupActiveChangeEvent | public | Event fired when a group is activated/deactivated. (Inherited from ITGIS_ControlLegendEvents) |
|
| GroupSelectEvent | public | Event fired upon group selection. (Inherited from ITGIS_ControlLegendEvents) |
|
| InvalidateItems | public | Forces invalidation of all the legend items. | |
| IsExpanded | public | Checks if the legend item is associated with the specific hierarchy group is expanded. | |
| IsExpanded_2 | public | Checks if the legend item is associated with the specific layer is expanded. | |
| LayerActiveChangeEvent | public | Event fired when a layer is activated/deactivated. (Inherited from ITGIS_ControlLegendEvents) |
|
| LayerParamsChangeEvent | public | Event fired when a layer parameters get changed. (Inherited from ITGIS_ControlLegendEvents) |
|
| LayerSelectEvent | public | Event fired upon layer selection. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnClick | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnDblClick | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnKeyDown | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnKeyPress | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnKeyUp | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnMouseDown | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnMouseMove | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnMouseUp | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnMouseWheel | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnMouseWheelDown | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OnMouseWheelUp | public | See documentation for TCustomControl in Delphi help. (Inherited from ITGIS_ControlLegendEvents) |
|
| OpenDialogEvent | public | Event fired upon opening of the layer properties dialog box. (Inherited from ITGIS_ControlLegendEvents) |
|
| OrderChangeEvent | public | Event fired upon a change of the order of layers. (Inherited from ITGIS_ControlLegendEvents) |
|
| PrintBmp | public | Print the control on the given bitmap. (Implements IGIS_PrintableControl.PrintBmp) |
|
| PrintClipboard | public | Prints the current state of the legend to the clipboard as a bitmap. | |
| TapDoubleEvent | public | TapDouble event. (Inherited from ITGIS_ControlLegendEvents) |
|
| TapLongEvent | public | TapLong event. (Inherited from ITGIS_ControlLegendEvents) |
|
| TapSimpleEvent | public | TapSimple event. (Inherited from ITGIS_ControlLegendEvents) |
|
Properties
Inherited
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| BiDiModeFromTranslation | public | Defines which BiDi we are using: the one from property or the one from translation | |
| BorderStyle | public | Border style for component windows. | |
| Color | public | See documentation for TCustomControl in Delphi help. | |
| CompactView | public | If True then the legend view is compacted - icons are smaller. | |
| DialogOptions | public | Options defining dialogs behavior. | |
| DrawIconStyle | public | Draw style of legend icons. | |
| Font | public | See documentation for TCustomControl in Delphi help. | |
| GIS_Group | public | Selected group. | |
| GIS_Layer | public | Selected layer. | |
| GIS_Layers | public | Selected layers. | |
| GIS_Viewer | public | Attached IGIS_Viewer object. | |
| Mode | public | Mode of the legend - list of layers or grouped tree view. | |
| Options | public | Options of the legend. | |
| ReverseOrder | public | True if the order of legend entries in the Layer mode should be reverse, i.e. | |
| SelectedNode | public | Selected node. | |
| SelectionColor | public | Selected item color background. | |
| SelectionFontColor | public | Selected item font color. | |
Remarks
Place this component on a form and connect GIS_Viewer to IGIS_Viewer object. Selected layer is available via GIS_Layer property.
Available metadata keys :
| Metadata | Values | Default | Description |
|---|---|---|---|
| TGIS_Legend.DefHeight | size in pixels at 96 dpi | 16 | Default item height. Recalculated based on Font Size |
| TGIS_Legend.DefHeight16 | size in pixels at 96 dpi | 16 | Default item height. |
| TGIS_Legend.DefLayerIconSize | size in pixels at 96 dpi | 24 | Default layer icon size. |
| TGIS_Legend.DefBmpSize | size in pixels at 96 dpi | 28 | Default size of bitmap[ used to present layer styles. |
References
2025/06/10 20:50