Skip to main content

TcxPivotGridCrossCell.GetSummaryByField(TcxPivotGridField,TcxPivotGridSummaryType) Method

Returns the summary value calculated for a particular field using the specified function.

Declaration

function GetSummaryByField(AField: TcxPivotGridField; ASummaryType: TcxPivotGridSummaryType): Variant; overload; virtual;

Parameters

Name Type
AField TcxPivotGridField
ASummaryType TcxPivotGridSummaryType

Returns

Type
Variant

Remarks

Summary values are calculated for all the data fields (including the invisible data fields) and the fields whose values are used to determine the sort order for the “sorted by summary“ fields. All these fields are stored in the pivot grid’s SummaryFields property.

Use the GetSummaryByField function to get the summary value calculated for the field passed as the AField parameter. The summary function used to calculate summary value is passed as the ASummaryType parameter. Alternatively, you can use the SummaryCells collection to access the calculated summary values.

See Also