IThreadSafeField.SortMode Property

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

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

PivotSortMode SortMode { get; }

VB.NET

ReadOnly Property SortMode As PivotSortMode

Property Value

Type	Description
PivotSortMode	A PivotSortMode value that specifies how the field’s data is sorted in sort mode.

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. Set the PivotGridOptionsOLAP.SortByCustomFieldValueDisplayText property to true to sort data by handling the PivotGridControl’s FieldValueDisplayText event. The field is not sorted against the custom text generated on the client side (for instance, if you modify the text via the PivotGridControl.FieldValueDisplayText event).
Custom	Enables custom sorting of the field’s data using the CustomFieldSort event or the CustomServerModeSort event in OLAP mode.
Key	Sorts the field’s data by key attributes (in OLAP mode).
ID	Sorts by a level member’s ID (in OLAP mode).
None	Data is not sorted - it is displayed in the order the data source specifies. This option is in effect only in OLAP mode.
DimensionAttribute	Sorts the field’s data by the OLAP member property (in OLAP mode). Set the PivotGridFieldBase.SortByAttribute property to specify the dimension attribute.

Remarks

The SortMode property provides thread-safe access to the field’s PivotGridFieldBase.SortMode property. To learn more, see PivotGridFieldBase.SortMode.

Use the SortMode property when handling events in asynchronous mode. For more information, see Asynchronous Mode.