PivotGridField.CollapseAllAsync() Method

Collapses all columns or rows of the specified Pivot Grid field asynchronously.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v25.1.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 PivotGridField.CollapseAll and PivotGridField.ExpandAll methods.

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