PivotGridControl.SetFieldSortingAsync(PivotGridField, PivotSortOrder, AsyncCompletedHandler) Method

Sets the specified sort order for the specified field asynchronously. Allows you to specify custom actions to be performed after this operation is completed.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public void SetFieldSortingAsync(
    PivotGridField field,
    PivotSortOrder sortOrder,
    AsyncCompletedHandler asyncCompleted
)
Public Sub SetFieldSortingAsync(
    field As PivotGridField,
    sortOrder As PivotSortOrder,
    asyncCompleted As AsyncCompletedHandler
)

Parameters

Name Type Description
field PivotGridField

A PivotGridField object that specifies a field whose sort order should be changed.

sortOrder PivotSortOrder

A PivotSortOrder enumeration member that specifies the sort order to be set for the field.

asyncCompleted AsyncCompletedHandler

A AsyncCompletedHandler delegate, referencing a method that should be executed after the operation is completed.

Remarks

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

The field sort order is specified by the PivotGridFieldBase.SortOrder property. To toggle the field sort order, use the PivotGridFieldBase.ChangeSortOrder (synchronous) or PivotGridControl.ChangeFieldSortOrderAsync (asynchronous) method.

See Also