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.v20.1.Core.dll

Declaration

[DefaultValue(PivotSortMode.Default)]
public PivotSortMode SortMode { get; set; }
<DefaultValue(PivotSortMode.Default)>
Public Property SortMode As PivotSortMode

Property Value

Type Default Description
PivotSortMode

Default

A PivotSortMode value that specifies how the field's data is sorted in sort 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 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