Skip to main content

PivotGroupFilterValues.BeginUpdate() Method

Locks the PivotGroupFilterValues object by disallowing visual updates until the EndUpdate or CancelUpdate method is called.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v24.2.Core.dll

Declaration

public virtual void BeginUpdate()

Remarks

Once the BeginUpdate method has been called, modifying the PivotGroupFilterValues‘s settings does not result in immediate repainting. So, multiple modifications can be made to the object without a major impact on performance or screen flickering. After all the desired operations have been finished, call the EndUpdate or CancelUpdate method. Use the EndUpdate method if the object needs to be immediately repainted after the changes have been applied. If the object’s visual settings haven’t been affected by the operations performed and the object should not be immediately updated, call the CancelUpdate method.

The BeginUpdate, EndUpdate and CancelUpdate methods use an internal counter to implement the update functionality. The counter’s initial value is 0. The BeginUpdate method increments the counter. The EndUpdate and CancelUpdate decrement the counter.

The object’s visual updates (change notifications) are forbidden if the counter’s value is greater than 0, and the updates are enabled if the counter’s value is 0.

Each call to BeginUpdate must be paired with a call to EndUpdate or CancelUpdate. To ensure that EndUpdate/CancelUpdate is always called even if an exception occurs, use the try…finally statement.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the BeginUpdate() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also