PivotGridField.SortMode Property
Gets or sets how the field’s data is sorted, when sorting is applied to it. This is a dependency property.
Namespace: DevExpress.Xpf.PivotGrid
Assembly: DevExpress.Xpf.PivotGrid.v18.2.dll
Declaration
Property Value
| Type | Description |
|---|---|
| FieldSortMode | A FieldSortMode enumeration member that specifies how the field’s data is sorted. |
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 | Enables custom sorting of the field’s data via the PivotGridControl.CustomFieldSort event. 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
The SortMode property determines the algorithm used to sort the field’s data (by display text, edit value or using a custom sorting algorithm).
To provide custom sorting, set the SortMode property to FieldSortMode.Custom and handle the PivotGridControl.CustomFieldSort event.
To apply sorting to a field, set the field’s PivotGridField.SortOrder property to FieldSortOrder.Ascending or FieldSortOrder.Descending. This will arrange the field’s values in ascending or descending order, using the algorithm that is specified by the SortMode property.