IMapLegend.Header

Syntax

Header: IMapLegendHeader;

Description

The Header property returns upper text parameters for a legend.

Example

Executing the example requires a form, a button named Button1 on the form, the UiMap component named UiMap1 that is a data source for the MapBox component. The UiMap1 component must have a connected map that contains a map indicator only.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);

Var

Map: IMap;

Layer: IMapLayer;

Legend: IMapLegend;

Header: IMapLegendHeader;

Font: IGxFont;

Begin

Map := UiMap1.Map;

Legend := New DxMapLegend.Create As IMapLegend;

Map.View.Legend := Legend;

Legend.Visible := True;

Legend.BeginUpdate;

Layer := Map.Layers.FindByName("Regions");

Legend.Visual := Layer.Visuals.Item(0);

Header := Legend.Header;

Header.Color := GxColor.FromName("Red");

Font := New GxFont.Create("Arial", 15, GxFontStyle.Bold);

Header.Font := Font;

Header.Text := "Legend";

Legend.EndUpdate;

End Sub Button1OnClick;

After executing the example the legend is displayed for the map indicator. The legend upper text contains the "Legend" word:

See also:

IMapLegend