TdxChartSimpleSeriesTotalLabel.TextFormat Property

Specifies a formatting pattern for the total label.

Declaration

property TextFormat: TdxChartTextFormat read; write;

Property Value

Type	Description
TdxChartTextFormat	The total label formatting pattern.

Remarks

Use the TextFormat property to define a custom formatting pattern for the total label. A formatting pattern can consist of static content and one or more placeholder fields. A placeholder field is an expression enclosed in curly brackets that starts with a supported placeholder variable followed by a colon and a value formatting expression.

Text Format Example

The following expression displays a total series value followed by a measurement unit: Total {TV:#,###.00}M sq.km.

Supported Placeholder Field Variables

{V} | {TV}

A total value in a simple series.

{S}

A series caption.

Tip

The Chart control supports all Spreadsheet-compatible formats.

Placeholder Field Errors

The total label displays the following string if the formatting pattern contains an unsupported placeholder field: 'Variable "" not found!'.

Default Value

The TextFormat property’s default value is an empty string.

Pie and Doughnut Views

The default TextFormat property value indicates that the total label displays the string 'Total: ' followed by a series total value without additional formatting:

The default total label formatting corresponds to the following formatting pattern: 'Total: {TV}'.

Doughnut View: Centered Total Label

The default TextFormat property value indicates that the total label displays the string 'Total: ' followed by a series total value label without additional formatting. The total value label is on the second line within the label:

The default formatting of a total label centered in a Doughnut Series corresponds to the following formatting patterns: 'Total:#13#10{TV}' (in Delphi) and "Total:\n{TV}" (in C++Builder).