User Tools

Site Tools


api:dk11:delphi:vcl.giscontrollegend.tgis_controllegend

TGIS_ControlLegend class

DK11 for Delphi | VCL.GisControlLegend.TGIS_ControlLegend | Classes | Constructors | Methods | Properties | Events

Visual Legend component.

Available also on: Delphi FMX | .NET WinForms | Java | ActiveX.

Syntax

// Delphi
type
  [ComponentPlatformsAttribute(pidWin32orpidWin64)]
  TGIS_ControlLegend = class( TCustomControl, IGIS_Subscribe, IGIS_PrintableControl )
  end;
// C++ Builder
class PASCALIMPLEMENTATION TGIS_ControlLegend : public TCustomControl
{
};

Inheritance

→ TCustomControl

Implements

Constructors

Inherited Overrides Protected
Name Visibility Description
Create public Constructor, creates an instance.
Destroy public Destructor, destroys the instance.

Methods

Inherited Overrides Protected
Name Visibility Description
ClearSelection protected Clear selection.
Collapse(IGIS_HierarchyGroup) public Collapses a legend item corresponding to a hierarchy group.
Collapse(IGIS_HierarchyGroup; Boolean; Boolean) public Collapses a legend item corresponding to a hierarchy group.
Collapse(TGIS_Layer) public Collapses a legend item corresponding to a layer.
CreateCopy public Prepare a copy of the control for printing.
(Implements IGIS_PrintableControl.CreateCopy)
CreateParams protected Startup parameter overriding.
Delete protected Overrides the default Delete method.
DrawBmp public Draw control on a provided bitmap.
Expand(IGIS_HierarchyGroup) public Expands of a legend item associated with the specific hierarchy group.
Expand(IGIS_HierarchyGroup; Boolean; Boolean) public Expands a legend item corresponding to a hierarchy group.
Expand(TGIS_Layer) public Expands a legend item associated with the specific layer.
FreeCopy public Release the copy of the control.
(Implements IGIS_PrintableControl.FreeCopy)
InvalidateItems public Forces invalidation of all the legend items.
IsExpanded(IGIS_HierarchyGroup) public Checks if the legend item associated with the specific hierarchy group is expanded.
IsExpanded(TGIS_Layer) public Checks if the legend item associated with the specific layer is expanded.
KeyDown protected Overrides the default KeyDown event behavior.
MouseDown protected Overrides the default MouseDown event behavior.
MouseMove protected Overrides the default MouseMove event behaviour.
MouseUp protected Overrides the default MouseUp event behaviour.
Paint public
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.
Repaint public
Resize public
Select protected Select node on treeview.
SetBiDiMode protected
SubscribedEvent public An event called automatically by the attached TGIS_ViewerWnd whenever there is a need to update the legend.
(Implements IGIS_Subscribe.SubscribedEvent)
TapDouble protected Event handler of the double tap action.
TapLong protected Event handler of the long tap action.
TapSingle protected Event handler of the single tap action.

Properties

Inherited Protected
Name Visibility Description
Align published See documentation for TCustomControl in Delphi help.
Anchors published See documentation for TCustomControl in Delphi help.
BiDiMode published See documentation for TCustomControl in Delphi help.
BiDiModeFromTranslation published Defines which BiDi we are using the one from property or the one from translation
BorderStyle published Border style for component windows.
Color published See documentation for TCustomControl in Delphi help.
CompactView published If True then the legend view is compacted - icons are smaller.
Ctl3D published See documentation for TCustomControl in Delphi help.
DialogOptions published Options defining dialogs behavior.
Enabled published See documentation for TCustomControl in Delphi help.
Font published Display font.
GIS_Group public Selected group.
GIS_Layer public Selected layer.
GIS_Viewer published Attached TGIS_ViewerWnd control.
HelpContext published See documentation for TCustomControl in Delphi help.
Hint published See documentation for TCustomControl in Delphi help.
InternalName public Used for internal use of TatukGIS.
(Implements IGIS_PrintableControl.InternalName)
Mode published Mode of the legend - list of layers or grouped tree view.
Options published Options of the legend.
ParentBiDiMode published See documentation for TCustomControl in Delphi help.
ParentColor published See documentation for TCustomControl in Delphi help.
ParentCtl3D published See documentation for TCustomControl in Delphi help.
ParentShowHint published See documentation for TCustomControl in Delphi help.
PopupMenu published See documentation for TCustomControl in Delphi help.
ReverseOrder published True if the order of legend entries in the Layer mode should be reverse, i.e.
Selected protected Selected node.
TabOrder published See documentation for TCustomControl in Delphi help.
TabStop published See documentation for TCustomControl in Delphi help.
Touch published See documentation for TCustomControl in Delphi help.
Visible published See documentation for TCustomControl in Delphi help.

Events

Inherited Protected
Name Visibility Description
LayerActiveChangeEvent published Event fired when a layer is activated/deactivated.
LayerParamsChangeEvent published Event fired when a layer parameters get changed.
LayerSelectEvent published Event fired upon layer selection.
OnClick published See documentation for TCustomControl in Delphi help.
OnDblClick published See documentation for TCustomControl in Delphi help.
OnDragDrop published See documentation for TCustomControl in Delphi help.
OnDragOver published See documentation for TCustomControl in Delphi help.
OnEndDrag published See documentation for TCustomControl in Delphi help.
OnEnter published See documentation for TCustomControl in Delphi help.
OnExit published See documentation for TCustomControl in Delphi help.
OnGesture published See documentation for TCustomControl in Delphi help.
OnKeyDown published See documentation for TCustomControl in Delphi help.
OnKeyPress published See documentation for TCustomControl in Delphi help.
OnKeyUp published See documentation for TCustomControl in Delphi help.
OnMouseDown published See documentation for TCustomControl in Delphi help.
OnMouseMove published See documentation for TCustomControl in Delphi help.
OnMouseUp published See documentation for TCustomControl in Delphi help.
OnMouseWheel published See documentation for TCustomControl in Delphi help.
OnMouseWheelDown published See documentation for TCustomControl in Delphi help.
OnMouseWheelUp published See documentation for TCustomControl in Delphi help.
OnStartDrag published See documentation for TCustomControl in Delphi help.
OpenDialogEvent published Event fired upon opening of the layer properties dialog box.
OrderChangeEvent published Event fired upon the change of the order of layers.
TapDoubleEvent published TapDouble event.
TapLongEvent published TapLong event.
TapSimpleEvent published TapSimple event.

Remarks

Place this component on a form and connect GIS_Viewer to TGIS_ViewerWnd. Selected layer is available via GIS_Layer property.

2020/05/30 16:35