PivotGridControl.SetFieldSortingAsync(PivotGridField, FieldSortOrder) Method

Sets the specified sort order for the specified field asynchronously.

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public Task<bool> SetFieldSortingAsync(
    PivotGridField field,
    FieldSortOrder sortOrder
)

VB.NET

Public Function SetFieldSortingAsync(
    field As PivotGridField,
    sortOrder As FieldSortOrder
) As Task(Of Boolean)

Parameters

Name	Type	Description
field	PivotGridField	A PivotGridField object that specifies a field whose sort order should be changed.
sortOrder	FieldSortOrder	A FieldSortOrder enumeration member that specifies the sort order to be set for the field.

Returns

Type	Description
Task<Boolean>	An asynchronous operation that returns true in case of success.

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.

If you need to perform specific actions after this operation is completed, use another overload of the SetFieldSortingAsync method that takes the asyncCompleted parameter, and pass a delegate that performs the required actions as this parameter.

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