Skip to main content

TcxSummaryEventOutArguments Record

Represents output arguments of the OnSummary event.

Declaration

TcxSummaryEventOutArguments = record

Remarks

Calculation of a summary involves iteration of item elements within a group and evaluation of a specific number (the number of item elements, sum, maximum of their values etc.). The OnSummary event occurs for every item element within a group.

The TcxSummaryEventArguments type describes input arguments of the OnSummary event. The following table describes type fields:

Field

Meaning

Value

Specifies the value of the item element for which the OnSummary event occurred.

SummaryValue

Identifies the intermediate summary value which was calculated in previous iterations.

Assume, a sum of elements is calculated. In the second iteration the SummaryValue contains the first element value. In the third iteration SummaryValue specifies the sum of values of two previous elements, etc.

SummaryValue is evaluated internally based on the summary type (sum, maximum of values, number of elements etc.) and the element value provided by the Value field.

CountValue

Determines the number of records for which the OnSummary event has already occurred to calculate a specific summary of the TcxDataSummaryItem type.

Done

Specifies whether the current Value should be ignored. If True, Value is not used to calculate a summary value. By default, Done is always set to False and all element values are involved in summary calculation.

Input arguments of the OnSummary event are provided by the TcxSummaryEventArguments type.

See Also