api:dk11:activex:tatukgis_xdk11.itgis_shape.getlabel_void
ITGIS_Shape.GetLabel method
DK for ActiveX | TatukGIS_XDK11.ITGIS_Shape.GetLabel | Methods | Properties
Returns the formatted label text for the current shape, including markup generated by the labeling expression.
Syntax
// C# public WideString GetLabel();
' VisualBasic Public Function GetLabel() As WideString
// Oxygene public function GetLabel : WideString;
Result
| Type | Description |
|---|---|
| WideString | Label text for the current shape, including formatting markup when defined by the layer labeling rules. |
Remarks
PURPOSE: Retrieve the display label for the current shape using the layer label expression and field substitution rules.
BEHAVIOR: Evaluates the active label expression for the current shape and returns the resulting text with any supported markup preserved.
CONSTRAINTS: The result depends on the current shape context and layer labeling configuration. Use GetLabelPlain for a plain-text version.
- The label value is valid and resolved only during the rendering process (must evaluate the sections based on the viewer current scale)
- Returned value may represent the last used section from the parameters list.
2026/07/05 01:25