PivotGridControl.CollapseAllAsync() Method

Collapses all columns and rows in a Pivot Grid control asynchronously.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v23.2.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public Task<bool> CollapseAllAsync()

VB.NET

Public Function CollapseAllAsync As Task(Of Boolean)

Returns

Type	Description
Task<Boolean>	An asynchronous operation that returns true in case of success.

Remarks

The CollapseAllAsync method is asynchronous. CollapseAllAsync starts to execute the related operation in a background thread, and returns the Pivot Grid control. The main UI thread remains unblocked to allow the application to continue responding to user actions. Refer to the following topic for more information: Asynchronous Mode.

To expand all columns and rows asynchronously, use the PivotGridControl.ExpandAllAsync method.

To collapse or expand all columns and rows synchronously, use the PivotGridControl.CollapseAll and PivotGridControl.ExpandAll methods, respectively.

You can specify whether a user can expand or collapse field values in the UI. For this, use the PivotGridFieldOptions.AllowExpand property.

Example

The following code snippet collapses all Pivot Grid columns and rows asynchronously:

C#

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

namespace WindowsFormsApp2 {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
            pivotGridControl1.OptionsBehavior.UseAsyncMode = true;
            ConfigureLayout();
        }
        async void ConfigureLayout() {
          await pivotGridControl1.CollapseAllAsync();
        }
    }
}

VB.NET

Imports DevExpress.XtraPivotGrid
Imports System.Windows.Forms

Namespace WindowsFormsApp2
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
            pivotGridControl1.OptionsBehavior.UseAsyncMode = True
            ConfigureLayout()
        End Sub
        Private Async Sub ConfigureLayout()
          Await pivotGridControl1.CollapseAllAsync()
        End Sub
    End Class
End Namespace