PivotGridControl.CollapseValueAsync(Boolean, Object[], AsyncCompletedHandler) Method

Collapses the specified column or row asynchronously. Allows you to specify custom actions to be performed after this operation is completed.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v14.2.dll

Declaration

C#

public void CollapseValueAsync(
    bool isColumn,
    object[] values,
    AsyncCompletedHandler asyncCompleted
)

VB.NET

Public Sub CollapseValueAsync(
    isColumn As Boolean,
    values As Object(),
    asyncCompleted As AsyncCompletedHandler
)

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.
asyncCompleted	AsyncCompletedHandler	An AsyncCompletedHandler delegate referencing a method that should be executed after the operation is completed.

Remarks

The CollapseValueAsync method is asynchronous. It starts executing the related operation in a background thread, and immediately returns control. The primary UI thread is not blocked, allowing the application to continue responding to end-user actions. For more information about the asynchronous mode, see Asynchronous Mode.

Consider the following PivotGridControl:

To collapse '1995' within "Aniseed Syrup", do the following:

C#

pivotGrid.CollapseValueAsync(true, 
    new object[] { "Aniseed Syrup", 1995 }, 
    delegate(AsyncOperationResult result) {
        // ...
    });

The image below shows the result:

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.