TcxCustomDataSummaryItem.Format Property

Specifies the format string to display a summary value.

Declaration

property Format: string read; write;

Property Value

Type
string

Remarks

Use the Format property to set the format pattern, which controls the manner in which a summary value is displayed. If an empty string is specified, default patterns retrieved by the TcxDataSummaryItems.DefaultFormat function are used.

If values in the associated item are of the float type, they are formatted by the FormatFloat function defined in the SysUtils unit. In this instance, the Format property identifies the format string passed to this function. See the FormatFloat function for details on format specifiers.

Date/time values are formatted using the DateToStr, TimeToStr and DateTimeToStr functions. If a value contains both time and date information, it is formatted by the DateTimeToStr function. Otherwise, either DateToStr or TimeToStr is used. The Format property specifies the prefix in this case. A string returned by the DateToStr, TimeToStr or DateTimeToStr function is added to Format. If the summary’s Kind property is skCount, the value is not formatted by the above-mentioned date/time procedures. Instead, FormatFloat is called and Format is passed to it as a parameter.