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.v19.2.Core.dll

Declaration

C#

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

VB.NET

<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.

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).

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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SortMode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-reorder-pivotgrid-rows-and-columns-by-drag-and-drop-e4545/CS/ReorderHelper.cs#L118

    field.Tag = orderList;
    field.SortMode = PivotSortMode.Custom;
}

how-to-sort-data-in-server-mode-using-the-customservermodesort-event-t264145/CS/WinFormsPivotGridCustomServerModeSort/Form1.cs#L29

// Sets fields' sort mode to Custom to raise the CustomServerModeSort event.
fieldCategoryName.SortMode = PivotSortMode.Custom;
fieldOrderMonth.SortMode = PivotSortMode.Custom;

customfieldsort-how-to-sort-field-values-by-invisible-data-column-values-e331/CS/CustomFieldSortExample/Form1.cs#L25

{
    fieldSalesPerson1.SortMode = ((CheckEdit)sender).Checked ? PivotSortMode.Custom : PivotSortMode.Default;
}

using-customfilterpopupitems-event-to-apply-custom-sort-order-to-filter-popup-items-e3247/CS/WindowsApplication1/Form1.cs#L48

rowField = pivotGridControl1.Fields.Add("Product", PivotArea.RowArea);
rowField.SortMode = PivotSortMode.Custom;
dataField = pivotGridControl1.Fields.Add("Count", PivotArea.DataArea);

how-to-sort-the-pivot-grids-data-by-olap-member-properties-t264133/CS/WinFormsPivotGridCustomOLAPSort/Form1.cs#L18

    //Sets a field's sort mode to Custom to raise the CustomServerModeSort event.
    fieldProduct.SortMode = PivotSortMode.Custom;
}

VB.NET

how-to-reorder-pivotgrid-rows-and-columns-by-drag-and-drop-e4545/VB/ReorderHelper.vb#L132

    field.Tag = orderList
    field.SortMode = PivotSortMode.Custom
End Sub

how-to-sort-data-in-server-mode-using-the-customservermodesort-event-t264145/VB/WinFormsPivotGridCustomServerModeSort/Form1.vb#L25

' Sets fields' sort mode to Custom to raise the CustomServerModeSort event.
fieldCategoryName.SortMode = PivotSortMode.Custom
fieldOrderMonth.SortMode = PivotSortMode.Custom

customfieldsort-how-to-sort-field-values-by-invisible-data-column-values-e331/VB/CustomFieldSortExample/Form1.vb#L22

Private Sub checkEdit1_CheckedChanged(ByVal sender As Object, ByVal e As EventArgs) Handles checkEdit1.CheckedChanged
    fieldSalesPerson1.SortMode = If(DirectCast(sender, CheckEdit).Checked, PivotSortMode.Custom, PivotSortMode.Default)
End Sub

using-customfilterpopupitems-event-to-apply-custom-sort-order-to-filter-popup-items-e3247/VB/WindowsApplication1/Form1.vb#L50

rowField = pivotGridControl1.Fields.Add("Product", PivotArea.RowArea)
rowField.SortMode = PivotSortMode.Custom
dataField = pivotGridControl1.Fields.Add("Count", PivotArea.DataArea)

how-to-sort-the-pivot-grids-data-by-olap-member-properties-t264133/VB/WinFormsPivotGridCustomOLAPSort/Form1.vb#L17

    'Sets a field's sort mode to Custom to raise the CustomServerModeSort event.
    fieldProduct.SortMode = PivotSortMode.Custom
End Sub