CustomSummaryEventArgs.TotalValueReady Property

Gets or sets whether the calculation stage of the custom summary calculation process should be skipped.

Namespace: DevExpress.Data

Assembly: DevExpress.Core.v18.1.dll

Declaration

public bool TotalValueReady { get; set; }
Public Property TotalValueReady As Boolean

Property Value

Type Description
Boolean

true if the calculation stage of the custom summary calculation process should be skipped; otherwise, false.

Controls that support custom summary calculation provide a specific event. For instance, the Grid Control provides the GridControl.CustomSummary event.

By default, the process of custom summary calculation consists of three stages: Start, Calculation and Finalization. During the Start stage the calculation event fires once with the CustomSummaryEventArgs.SummaryProcess parameter set to CustomSummaryProcess.Start. During the Calculation stage the event is called multiple times - once for each record. Finally, during the last stage the event is called once with the CustomSummaryEventArgs.SummaryProcess parameter set to CustomSummaryProcess.Finalize.

The TotalValueReady property allows you to interrupt the process of summary calculation during the Start stage. You cannot interrupt the process in the other stages. This can be useful if you need to calculate a custom summary during the Start or Finalization stage while skipping the time-consuming Calculation stage.

If the TotalValueReady property is set to true the Calculation stage is skipped and the Finalization stage starts immediately (the summary calculation event will be called with the CustomSummaryEventArgs.SummaryProcess parameter set to CustomSummaryProcess.Finalize).

See Also