PivotGridControl.EndUpdate() Method

Unlocks the PivotGridControl object after a call to the BeginUpdate method and causes an immediate visual update.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

C#

public virtual void EndUpdate()

VB.NET

Public Overridable Sub

Remarks

See PivotGridControl.BeginUpdate to learn more.

Example

The following example demonstrates how to lock the pivot grid, thus preventing it from being redrawn while a sequence of operations that affect its appearance and/or functionality is being performed.In this example, the pivot grid is transposed by moving Row Fields to the Column Area, and vice versa. Prior to this, the BeginUpdate method is called to lock the pivot grid. When the transposition is completed, the pivot grid is unlocked via the EndUpdate method. To ensure that the EndUpdate method is always called even if an exception occurs, calls to the BeginUpdate and EndUpdate methods are wrapped in a try…finally statement.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-lock-pivot-grid-updates-e2723

Form1.cs

using System;
using System.Data;
using System.Windows.Forms;
using DevExpress.XtraPivotGrid;

namespace XtraPivotGrid_BeginEndUpdate {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }
        private void Form1_Load(object sender, EventArgs e) {
            pivotGridControl1.DataSource = GetDataTable();
        }
        private void btnBegin_Click(object sender, EventArgs e) {
            DateTime startTime = DateTime.Now;

            // If an appropriate option is enabled, 
            // locks the pivot grid to prevent further updates.
            if (rbLocked.Checked) pivotGridControl1.BeginUpdate();
            try {

                // Initiates transposition.
                Transpose();
            }
            finally {

                // If the pivot grid has been locked, unlocks it, allowing further updates.
                if (rbLocked.Checked) pivotGridControl1.EndUpdate();
            }

            // Displays the amount of time taken by the transposition.
            TimeSpan duration = DateTime.Now - startTime;
            MessageBox.Show("Transposition took " + 
                duration.TotalSeconds.ToString("F2") + " seconds");
        }

        // Transposes the pivot grid by moving Row Fields to the Column Area, and vice versa.
        private void Transpose() {
                foreach(PivotGridField field in pivotGridControl1.Fields) {
                    if (field.Area == PivotArea.RowArea)
                        field.Area = PivotArea.ColumnArea;
                    else if (field.Area == PivotArea.ColumnArea)
                        field.Area = PivotArea.RowArea;
                }
        }

        // Generates pivot grid data.
        public static DataTable GetDataTable() {
            DataTable table = new DataTable();
            table.Columns.Add("A", typeof(string));
            table.Columns.Add("B", typeof(string));
            table.Columns.Add("Data", typeof(int));
            for (int i = 0; i < 1000; i++)
                for (int j = 0; j < 500; j++)
                    table.Rows.Add('A' + i.ToString(), 'B' + j.ToString(), ((int)i / 100));
            return table;
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Data
Imports System.Windows.Forms
Imports DevExpress.XtraPivotGrid

Namespace XtraPivotGrid_BeginEndUpdate
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            pivotGridControl1.DataSource = GetDataTable()
        End Sub
        Private Sub btnBegin_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnBegin.Click
            Dim startTime As DateTime = DateTime.Now

            ' If an appropriate option is enabled, 
            ' locks the pivot grid to prevent further updates.
            If rbLocked.Checked Then
                pivotGridControl1.BeginUpdate()
            End If
            Try

                ' Initiates transposition.
                Transpose()
            Finally

                ' If the pivot grid has been locked, unlocks it, allowing further updates.
                If rbLocked.Checked Then
                    pivotGridControl1.EndUpdate()
                End If
            End Try

            ' Displays the amount of time taken by the transposition.
            Dim duration As TimeSpan = DateTime.Now.Subtract(startTime)
            MessageBox.Show("Transposition took " & duration.TotalSeconds.ToString("F2") & " seconds")
        End Sub

        ' Transposes the pivot grid by moving Row Fields to the Column Area, and vice versa.
        Private Sub Transpose()
                For Each field As PivotGridField In pivotGridControl1.Fields
                    If field.Area = PivotArea.RowArea Then
                        field.Area = PivotArea.ColumnArea
                    ElseIf field.Area = PivotArea.ColumnArea Then
                        field.Area = PivotArea.RowArea
                    End If
                Next field
        End Sub

        ' Generates pivot grid data.
        Public Shared Function GetDataTable() As DataTable
            Dim table As New DataTable()
            table.Columns.Add("A", GetType(String))
            table.Columns.Add("B", GetType(String))
            table.Columns.Add("Data", GetType(Integer))
            For i As Integer = 0 To 999
                For j As Integer = 0 To 499
                    table.Rows.Add("A"c + i.ToString(), "B"c + j.ToString(), (CInt(Fix(i)) / 100))
                Next j
            Next i
            Return table
        End Function
    End Class
End Namespace

Related GitHub Examples

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

VB.NET

winforms-pivot-grid-connect-to-an-olap-datasource/VB/WinOlapRetrieveFieldsExample/Form1.vb#L37

pivotGridControl1.Fields("[Measures].[Internet Sales Amount]").Visible = True
pivotGridControl1.EndUpdate()
' Resize columns automatically.

how-to-avoid-production-of-unnecessary-column-and-merging-of-cells-in-excel-export-e2346/VB/WindowsApplication53/Form1.vb#L55

pivotGridControl1.OptionsView.ShowGrandTotalsForSingleValues = True
pivotGridControl1.EndUpdate()

how-to-apply-summary-filter-e4390/VB/XtraPivotGrid_ApplySummaryFilter/Form1.vb#L33

Finally
    pivotGridControl1.EndUpdate()
End Try

how-to-conditionally-format-the-style-of-pivot-grid-cells-e2312/VB/Form1.vb#L74

pivot.OptionsData.DataFieldUnboundExpressionMode = DataFieldUnboundExpressionMode.UseSummaryValues
pivot.EndUpdate()

how-to-lock-pivot-grid-updates-e2723/VB/XtraPivotGrid_BeginEndUpdate/Form1.vb#L32

If rbLocked.Checked Then
    pivotGridControl1.EndUpdate()
End If

C#

how-to-apply-summary-filter-e4390/CS/XtraPivotGrid_ApplySummaryFilter/Form1.cs#L32

finally {
    pivotGridControl1.EndUpdate();
}

how-to-conditionally-format-the-style-of-pivot-grid-cells-e2312/CS/Form1.cs#L75

    DataFieldUnboundExpressionMode.UseSummaryValues;
pivot.EndUpdate();

how-to-lock-pivot-grid-updates-e2723/CS/XtraPivotGrid_BeginEndUpdate/Form1.cs#L28

    // If the pivot grid has been locked, unlocks it, allowing further updates.
    if (rbLocked.Checked) pivotGridControl1.EndUpdate();
}

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/CS/E4669CS/CustomFieldFilterControl.cs#L65

    }
_field.PivotGrid.EndUpdate();

how-to-use-an-external-filtercontrol-to-filter-a-pivotgridcontrol-e2170/CS/WinFormsExample/Form1.cs#L18

myPivotGridControl1.Fields["DataField2"].Area = DevExpress.XtraPivotGrid.PivotArea.DataArea;
myPivotGridControl1.EndUpdate();
filterControl1.SourceControl = myPivotGridControl1.FilterSourceControl;