PivotGridControl.ClearFieldSortingAsync(PivotGridField) Method

Clears field sorting asynchronously in OLAP mode.

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public Task<bool> ClearFieldSortingAsync(
    PivotGridField field
)

VB.NET

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

Parameters

Name	Type	Description
field	PivotGridField	A PivotGridField object that specifies the field whose sort order should be changed.

Returns

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

Remarks

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

This method switches the field sort order to the one defined by the OLAP server.

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