PivotGridControl.ChangeFieldExpandedAsync(PivotGridField, Boolean, AsyncCompletedHandler) Method

Expands or collapses all values of the specified field 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 ChangeFieldExpandedAsync(
    PivotGridField field,
    bool expand,
    AsyncCompletedHandler asyncCompleted
)

VB.NET

Public Sub ChangeFieldExpandedAsync(
    field As PivotGridField,
    expand As Boolean,
    asyncCompleted As AsyncCompletedHandler
)

Parameters

Name	Type	Description
field	PivotGridField	A PivotGridField object that specifies the field whose values should be expanded/collapsed.
expand	Boolean	true to expand field values; false to collapse them.
asyncCompleted	AsyncCompletedHandler	An AsyncCompletedHandler delegate, referencing a method that should be executed after the operation is completed.

Remarks

The ChangeFieldExpandedAsync 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.

To collapse or expand all values of a particular field synchronously, use the PivotGridField.CollapseAll and PivotGridField.ExpandAll methods, respectively.

To collapse or expand a specific field value, use the PivotGridControl.CollapseValueAsync and PivotGridControl.ExpandValueAsync methods, respectively (or the PivotGridControl.CollapseValue and PivotGridControl.ExpandValue methods, to do this synchronously).

Field values can be collapsed and expanded by end-users, if the field's PivotGridField.AllowExpand property is set to true.