TreeListCustomSummaryEventArgs.IsTotalValueReady Property

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

Namespace: DevExpress.Xpf.Grid.TreeList

Assembly: DevExpress.Xpf.Grid.v20.1.dll

Declaration

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

Property Value

Type Description
Boolean

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

Remarks

The TreeList supports custom summary calculation and provides the TreeListView.CustomSummary event.

By default, the process of custom summary calculation consists of three stages: Start, Calculation and Finalization:

The IsTotalValueReady property allows you to interrupt the process of summary calculation during the Calculation 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 IsTotalValueReady 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