ASPxPivotGrid.BeginUpdate() Method

Prevents the ASPxPivotGrid from being rendered until the ASPxPivotGrid.EndUpdate method is called.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public void BeginUpdate()

VB.NET

Public Sub BeginUpdate

Remarks

The ASPxPivotGrid allows a sequence of operations that affect its appearance and/or functionality to be performed without having the control render itself after each modification. To do this, the code performing sequential changes to the ASPxPivotGrid must be enclosed within calls to the ASPxPivotGrid.BeginUpdate and ASPxPivotGrid.EndUpdate methods. This improves performance and avoids unnecessary render operations.

The BeginUpdate method locks the pivot grid control until the ASPxPivotGrid.EndUpdate method is called. Any changes made after a call to the BeginUpdate method don’t force the control to update itself. The ASPxPivotGrid.EndUpdate method invalidates and unlocks the pivot grid so that any further changes are applied immediately.

If the BeginUpdate method has been called several times, the ASPxPivotGrid.EndUpdate method must be called as many times as the BeginUpdate. Otherwise, the control stays locked. To ensure that the ASPxPivotGrid.EndUpdate method is always called even if an exception occurs, wrap any calls to BeginUpdate and ASPxPivotGrid.EndUpdate methods in a try…finally statement.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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.

C#

web-forms-pivot-grid-group-field-values-into-the-specified-intervals/CS/CustomGroupInterval/Default.aspx.cs#L34

protected void ASPxComboBox1_SelectedIndexChanged(object sender, EventArgs e) {
    ASPxPivotGrid1.BeginUpdate();
    switch(SelectedDemo) {

aspxpivotgrid-field-calculation-bindings/CS/AspNetWebFormsPivotFieldCalculationBindings/Default.aspx.cs#L11

PivotGridField fieldCountry = ASPxPivotGrid1.Fields["fieldCountry"];
ASPxPivotGrid1.BeginUpdate();
try {

aspxpivotgrid-layout-upgrade-event/CS/ASPxPivotGridLayoutUpgradeEvent/Default.aspx.cs#L11

PivotGridField fieldProductName = ASPxPivotGridOld.Fields["fieldProductName"];
ASPxPivotGridOld.BeginUpdate();
try {

VB.NET

web-forms-pivot-grid-group-field-values-into-the-specified-intervals/VB/CustomGroupInterval/Default.aspx.vb#L41

Protected Sub ASPxComboBox1_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
    ASPxPivotGrid1.BeginUpdate()
    Select Case SelectedDemo

aspxpivotgrid-field-calculation-bindings/VB/AspNetWebFormsPivotFieldCalculationBindings/Default.aspx.vb#L13

Dim fieldCountry As PivotGridField = ASPxPivotGrid1.Fields("fieldCountry")
ASPxPivotGrid1.BeginUpdate()
Try

aspxpivotgrid-layout-upgrade-event/VB/ASPxPivotGridLayoutUpgradeEvent/Default.aspx.vb#L12

Dim fieldProductName As PivotGridField = ASPxPivotGridOld.Fields("fieldProductName")
ASPxPivotGridOld.BeginUpdate()
Try