TcxDataSummaryItems.DefaultFormat(TcxSummaryValueType,TcxSummaryKind,Boolean) Method

Retrieves the default format string for a summary identified by its type, position, and the type of argument values.

Declaration

function DefaultFormat(AValueType: TcxSummaryValueType; ASummaryKind: TcxSummaryKind; AIsFooter: Boolean): string; virtual;

Parameters

Name	Type
AValueType	TcxSummaryValueType
ASummaryKind	TcxSummaryKind
AIsFooter	Boolean

Returns

Type
string

Remarks

This function is called to determine the format pattern if a summary’s Format property is set to an empty string.

AVarType specifies the type of summary values (arguments).

ASummaryKind specifies the summary type.

AIsFooter indicates if a summary is painted within the footer panel or within the group panel.

The DefaultFormat function retrieves the following format strings in accordance to the parameter values passed to the function, as shown in the table below.

Summary Kind	Float values		Date/time values		Currency values
	colspan=”6” |
	Footer Panel	Group Panel	Footer Panel	Group Panel	Footer Panel	Group Panel
skSum	‘0.00;-0.00’	‘SUM=0.00;SUM=-0.00’	‘’	‘SUM=’	‘%s;%s’	‘SUM=%s;SUM=%s’
skMin	‘MIN=0.00;MIN=-0.00’	‘MIN=0.00;MIN=-0.00’	‘MIN=’	‘MIN=’	‘MIN=%s;MIN=%s’	‘MIN=%s;MIN=%s’
skMax	‘MAX=0.00;MAX=-0.00’	‘MAX=0.00;MAX=-0.00’	‘MAX=’	‘MAX=’	‘MAX=%s;MAX=%s’	‘MAX=%s;MAX=%s’
skCount	‘0’	‘COUNT=0’	‘0’	‘COUNT=0’	‘0’	‘COUNT=0’
skAverage	‘AVG=0.00;AVG=-0.00’	‘AVG=0.00;AVG=-0.00’	‘AVG=’	‘AVG=’	‘AVG=%s;AVG=%s’	‘AVG=%s;AVG=%s’

For currency value format strings, two %s entries correspond to the positive and negative currency formats obtained from the CurrencyFormat property of an object returned by the cxFormatController global function.

Refer to the TNumericField.DisplayFormat property’s topic in the Delphi (C++ Builder) documentation for more information on formatting values.