PivotGridControl.CollapseValueAsync(Boolean, Object[]) Method

Collapses the specified column or row asynchronously.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v23.2.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public Task<bool> CollapseValueAsync(
    bool isColumn,
    object[] values
)

VB.NET

Public Function CollapseValueAsync(
    isColumn As Boolean,
    values As Object()
) As Task(Of Boolean)

Parameters

Name	Type	Description
isColumn	Boolean	true to collapse a column; false to collapse a row.
values	Object[]	An array of field values that identify the column/row to be collapsed.

Returns

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

Remarks

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

Consider the following Pivot Grid control:

To collapse the “Austria” column (within the “Alice Mutton” column), use the following code:

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.CollapseValueAsync(true, new object[] {"Alice Mutton", "Austria"});
        }
    }
}

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.CollapseValueAsync(True, New Object() {"Alice Mutton", "Austria"})
        End Sub
    End Class
End Namespace

The result of this operation is shown below:

To collapse a column or row synchronously, use the PivotGridControl.CollapseValue method.

To expand a column or row, use the PivotGridControl.ExpandValueAsync (asynchronous) or PivotGridControl.ExpandValue (synchronous) method.