PivotGridControl.ExpandAllRowsAsync() Method

Namespace : DevExpress.XtraPivotGrid

Assembly : DevExpress.XtraPivotGrid.v25.2.dll

NuGet Package : DevExpress.Win.PivotGrid

Declaration

C#
VB.NET

csharp

public Task<bool> ExpandAllRowsAsync()

Public Function ExpandAllRowsAsync As Task(Of Boolean)

Returns

Type	Description
Task<Boolean>

An asynchronous operation that returns true in case of success.

Remarks

The ExpandAllRowsAsync method is asynchronous. ExpandAllRowsAsync 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 rows:

CollapseAllRowsAsyncCollapses all rows asynchronously.ExpandAllRows()Expands all rows.CollapseAllRowsCollapses all rows.

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

ExpandAllColumnsAsyncExpands all columns asynchronously.ExpandAllColumnsExpands all columns.CollapseAllColumnsCollapses all columns.CollapseAllColumnsAsyncCollapses all columns asynchronously.

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 expand all rows in the Pivot Grid asynchronously. The image below displays the resulting Pivot Grid with expanded rows for the Country and City fields.

C#
VB.NET

csharp

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
            PivotGridField fieldCountry = pivotGridControl1.Fields.Add("Country", PivotArea.RowArea);
            fieldCountry.DataBinding = new DataSourceColumnBinding("[Customer].[Country].[Country]");
            fieldCountry.Name = "fieldCountry";

            PivotGridField fieldCity = pivotGridControl1.Fields.Add("City", PivotArea.RowArea);
            fieldCity.DataBinding = new DataSourceColumnBinding("[Customer].[City].[City]");
            fieldCity.Name = "fieldCity";
            // ...
            await pivotGridControl1.EndUpdateAsync();

            await pivotGridControl1.ExpandAllRowsAsync();
        }
    }
}

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
            Dim fieldCountry As PivotGridField = pivotGridControl1.Fields.Add("Country", PivotArea.RowArea)
            fieldCountry.DataBinding = New DataSourceColumnBinding("[Customer].[Country].[Country]")
            fieldCountry.Name = "fieldCountry"

            Dim fieldCity As PivotGridField = pivotGridControl1.Fields.Add("City", PivotArea.RowArea)
            fieldCity.DataBinding = New DataSourceColumnBinding("[Customer].[City].[City]")
            fieldCity.Name = "fieldCity"
            ' ...
            Await pivotGridControl1.EndUpdateAsync()

            Await pivotGridControl1.ExpandAllRowsAsync()
        End Sub
    End Class
End Namespace