PivotGridFieldBase.SortMode Property

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

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v21.1.Core.dll

Declaration

[DefaultValue(PivotSortMode.Default)]
public PivotSortMode SortMode { get; set; }

Property Value

Type Default Description
PivotSortMode

Default

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 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 PivotSortMode.Custom and handle the CustomFieldSort event. To provide custom sorting in OLAP and server mode, handle the CustomServerModeSort event. To sort the pivot grid field’s data by an OLAP member property, set the SortMode property to PivotSortMode.DimensionAttribute and assign the property name to PivotGridFieldBase.SortByAttribute property.

For more information, refer to the platform-specific API articles:

WinForms ASP.NET ASP.NET MVC WPF
CustomFieldSort CustomFieldSort CustomFieldSort CustomFieldSort
CustomServerModeSort CustomServerModeSort CustomServerModeSort CustomServerModeSort

To apply sorting to a field, set the field’s PivotGridFieldBase.SortOrder property to PivotSortOrder.Ascending or PivotSortOrder.Descending. This will arrange the field’s values in ascending or descending order using the algorithm that is specified by the SortMode property.

See Also