Skip to main content

ColumnBase.SortMode Property

Gets or sets how the column’s data is sorted when sorting is applied to it. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core


public ColumnSortMode SortMode { get; set; }

Property Value

Type Default Description
ColumnSortMode Default

A ColumnSortMode enumeration value that specifies the sort mode.

Available values:

Name Description

The actual sort mode is determined by a control. See the property description for more details.


Sorts the column’s data by the column’s edit values (these are synchronized with the bound data source’s values).


Sorts the column’s data by the column’s display text (the strings displayed within the column’s cells).


Applies sort options specified in the CustomColumnSort event handler.

In data grids, this mode also applies group options from the CustomColumnGroup event handler.


The SortMode property specifies the algorithm used to sort the column’s data (by display text, edit value, or a custom sorting algorithm).

The Default option is DisplayText for columns that use in-place editors inherited from the LookUpEditSettingsBase class (ComboBoxEditSettings, LookUpEditSettings). The Default option is Value for other columns.

Follow the steps below to apply custom sort and group options:

  1. Specify the ColumnBase.SortOrder or GridColumn.GroupIndex property.
  2. Set the SortMode property to Custom.
  3. Handle the GridControl.CustomColumnSort or GridControl.CustomColumnGroup event.

Refer to the following help topics for more information: Sorting Modes and Custom Sorting, Group Modes and Custom Grouping.


The following example demonstrates how to use custom rules to sort data in the GridControl:

DevExpress WPF | Grid Control - Custom Sort Rules

View Example: How to Use Custom Rules to Sort Data

<dxg:GridControl x:Name="grid"
        <dxg:GridColumn FieldName="Day" GroupIndex="0" SortMode="Custom"/>
        <dxg:GridColumn FieldName="Employee"/>
void OnCustomColumnSort(object sender, CustomColumnSortEventArgs e) {
    if(e.Column.FieldName == "Day") {
        int dayIndex1 = GetDayIndex(e.Value1);
        int dayIndex2 = GetDayIndex(e.Value2);
        e.Result = dayIndex1.CompareTo(dayIndex2);
        e.Handled = true;
int GetDayIndex(object day) {
    return (int)Enum.Parse(typeof(DayOfWeek), (string)day);

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


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.

See Also