PivotGridControl.ChangeFieldSortOrderAsync(PivotGridField) Method

Toggles the sort order of the specified field asynchronously.

Namespace : DevExpress.Xpf.PivotGrid

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

NuGet Package : DevExpress.Wpf.PivotGrid

Declaration

C#
VB.NET

csharp

public Task<bool> ChangeFieldSortOrderAsync(
    PivotGridField field
)

Public Function ChangeFieldSortOrderAsync(
    field As PivotGridField
) As Task(Of Boolean)

Parameters

Name	Type	Description
field	PivotGridField

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

Returns

Type	Description
Task<Boolean>

An asynchronous operation that returns true in case of success.

Remarks

The ChangeFieldSortOrderAsync 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 ChangeFieldSortOrderAsync method that takes the asyncCompleted parameter, and pass a delegate that performs the required actions as this parameter.

You can also use the PivotGridControl.SetFieldSortingAsync method to specify the sort order for a field asynchronously.

The field sort order is specified by the PivotGridField.SortOrder property. To toggle the field sort order synchronously, use the PivotGridField.ChangeSortOrder method.