TcxCustomDataSummaryItem.FormatValue(Variant,Boolean) Method

Returns a string representation of a specific summary object value.

Declaration

function FormatValue(const AValue: Variant; AIsFooter: Boolean): string; virtual;

Parameters

Name	Type
AValue	Variant
AIsFooter	Boolean

Returns

Type
string

Remarks

The AValue parameter refers to the summary value.

The AIsFooter parameter is equal to True when the summary value is displayed either in a footer panel or a group footer panel.

By default, this function formats the summary value using the format pattern specified by the Format property. If this property is assigned an empty string, the default format string is used as specified by the DefaultFormat function of a collection summary that the summary object belongs to.

Note

You can handle the OnGetText event to customize the return value of the FormatValue function.