Skip to main content

PivotGridControl.CollapseValueAsync(Boolean, Object[]) Method

Collapses the specified column or row asynchronously.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v24.1.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

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

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:

CollapseValue_method

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

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"});
        }
    }
}

The result of this operation is shown below:

CollapseValue_method_res

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.

See Also