IMapLegend.CustomFormat

Syntax

CustomFormat: String;

Description

The CustomFormat property enables the user to set a custom number format for a legend.

Comments

The data display format is formed by reserved format codes. Codes are described in theNumber Format section. Set data display format in the Russian version of format code to correctly show while changing language interface settings of Foresight Analytics Platform. For example, the format of date display DD.MM.YYYY will be correctly displayed in any selected system interface language. At the same time the format DD.MM.YYYY will be available only in the English version.

Example

Executing the example requires a form with the following components: the Button component named Button1, the MapBox component named MapBox1, and the UiMap component named UiMap1. UiMap1 is a data source for MapBox1. The UiMap1 component must have a connected map that contains a map indicator only.

The example is a handler of the OnClick event for the Button1 component.

Add links to the ExtCtrls, Forms, and Map system assemblies.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Var
    Map: IMap;
    Layer: IMapLayer;
    Legend: IMapLegend;
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);
    Legend.CustomFormat := "0,0";
    Legend.EndUpdate;
End Sub Button1OnClick;

After executing the example the legend is displayed for the map indicator. The values in the legend are displayed in numeric format with one decimal digit.