TcxGridChartSeries.ValueCaptionFormat Property

Specifies the formatting pattern used to determine the captions of the series values.

Declaration

property ValueCaptionFormat: string read; write;

Property Value

Type
string

Remarks

The caption of a value in a series (a data label on a series value) is determined using the series values of the series by means of standard routines unless the formatting pattern is set via the ValueCaptionFormat property. In this case, the pattern is used to format the resulting caption of the series value. For instance, when a caption is determined using the ‘Profit/Loss = $,0.00;-$,0.00’ pattern, the pattern will be treated as follows. The 0.00 part will be substituted with the series value. The two zeros after the point identify the number of digits in the resulting caption of the series value to the right of the decimal point. A comma stands for a thousands separator. A semicolon separates the two patterns used to display positive and negative values, respectively. Other characters do not have any special meaning and are displayed as they are.

Note

For additional information on formatting numeric values, see the FormatFloat function topic.

The diagram’s CaptionPosition property controls the generic appearance of the captions of series values and their positions within the chart.

Note

The value of the ValueCaptionFormat property is also used to determine tick-mark labels (see the description of the TcxGridChartHistogramAxisValue.GetTickMarkLabel function for details).