PivotGridControl.CollapseAllColumnsAsync() Method

Collapses all columns asynchronously.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.2.dll

Declaration

C#

public Task<bool> CollapseAllColumnsAsync()

VB.NET

Public Function CollapseAllColumnsAsync As Task(Of Boolean)

Returns

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

Remarks

The CollapseAllColumnsAsync method is asynchronous. CollapseAllColumnsAsync 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.

Use the following methods to collapse or expand Pivot Grid columns:

ExpandAllColumnsAsync

Expands all columns asynchronously.

ExpandAllColumns

Expands all columns.

CollapseAllColumns

Collapses all columns.

Use the following methods to collapse or expand Pivot Grid rows:

ExpandAllRowsAsync

Expands all rows asynchronously.

CollapseAllRowsAsync

Collapses all rows asynchronously.

ExpandAllRows()

Expands all rows.

CollapseAllRows

Collapses all rows.

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 example shows how to collapse all columns in Pivot Grid the asynchronously. The image below displays the resulting Pivot Grid with collapsed columns for the Country and City fields.

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() {
            pivotGridControl1.BeginUpdate();
            // Create and configure Pivot Grid fields
            await pivotGridControl1.EndUpdateAsync();
            await pivotGridControl1.CollapseAllColumnsAsync();
        }
    }
}

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()
            pivotGridControl1.BeginUpdate()
            ' Create and configure Pivot Grid fields
            Await pivotGridControl1.EndUpdateAsync()
            Await pivotGridControl1.CollapsedAllColumnsAsync()
        End Sub
    End Class
End Namespace