Skip to main content
A newer version of this page is available. .

IThreadSafeField.SortMode Property

Gets how data is sorted when sorting is applied to the field.

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.PivotGrid, DevExpress.Wpf.PivotGrid

Declaration

FieldSortMode SortMode { get; }

Property Value

Type Description
FieldSortMode

A FieldSortMode enumeration member that specifies how data is sorted when sorting is applied to the field.

Available values:

Name Description
Default

Sorts the field’s data by the field’s values (these are synchronized with the values from the bound data source).

Value

Sorts the field’s data by the field’s values (these are synchronized with the values from the bound data source).

DisplayText

Sorts the field’s data by the field’s display text (the strings displayed within the field values).

In OLAP mode, the data is sorted against the text generated on the server. The field will not be sorted against the custom text generated on the client side (for instance, if you modify the text via the PivotGridControl.FieldValueDisplayText event).

Custom

Forces the PivotGridControl to fire the PivotGridControl.CustomFieldSort event that allows you to specify a custom algorithm to sort the field values.

Not supported in OLAP mode.

Key

Sorts the field’s data by key attributes. This option is in effect only in OLAP mode.

ID

Sorts by a level member’s ID (in OLAP mode).

None

Data is not sorted, and it’s displayed in the order specified by the data source. This option is in effect only in OLAP mode.

DimensionAttribute

Sorts the field’s data by an OLAP member property (in OLAP mode).

Remarks

This property returns the PivotGridField.SortMode property value.

See Also