Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

TcxSummaryEventOutArguments.Done Field

Specifies if the active summary calculation algorithm ignores the currently processed record value.

#Declaration

Delphi
Done: Boolean

#Field Value

Type Description
Boolean
False
Default. The summary item applies its active calculation algorithm to the currently processed record value.
True
The summary item ignores the currently processed record value. Use this option to exclude the currently processed record value from summary calculation.

#Remarks

A summary item iterates through all its target records to calculate a summary according to the selected predefined algorithm.

You can assign True to the Done field within an OnSummary event handler to exclude the currently processed record value from summary calculation as demonstrated in the code example below.

#Code Example: Exclude Null Variant Values from Summary Calculation

The following code example excludes all Null Variant record values from summary calculation:

procedure TMyForm.cxGrid1DBTableView1DataControllerSummaryDefaultGroupSummaryItemsSummary(
  ASender: TcxDataSummaryItems; Arguments: TcxSummaryEventArguments;
  var OutArguments: TcxSummaryEventOutArguments);
begin
  if (VarIsNull(OutArguments.Value)) then // If the currently processed value is Null Variant
    OutArguments.Done := True;  // Ignores the Null Variant record value
end;
See Also