Skip to main content
A newer version of this page is available. .
Tab

GridDataColumnSettings.SortMode Property

Gets or sets how the column’s (row’s for ASPxVerticalGrid) data is sorted when sorting is applied to it.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.2.dll

Declaration

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

Property Value

Type Default Description
ColumnSortMode **Default**

One of the ColumnSortMode enumeration values.

Available values:

Name Description
Default

Sorts the column’s data according to the type of the editor assigned to the column.

The Default option is equivalent to DisplayText for columns that use LookUpEdit, ImageComboBoxEdit and HypertextLabel (RepositoryItemHypertextLabel) in-place editors.

The Default option is equivalent to Value for other columns. Note that for certain editors (TextEdit, ComboBoxEdit, etc) the edit values match the display values.

Value

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

DisplayText

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

Custom

Enables custom sorting of a column’s data. To implement custom sorting, handle the ColumnView.CustomColumnSort event in the GridControl, and the TreeList.CompareNodeValues event in the TreeList.

In the GridControl, the Custom mode also enables custom grouping of rows when grouping is applied against the current column. To implement custom grouping, handle the GridView.CustomColumnGroup event.

Property Paths

You can access this nested property as listed below:

Show 90 property paths
Library Object Type Path to SortMode
ASP.NET Controls and MVC Extensions CardViewBinaryImageColumn
.Settings.SortMode
CardViewButtonEditColumn
.Settings.SortMode
CardViewCheckColumn
.Settings.SortMode
CardViewColorEditColumn
.Settings.SortMode
CardViewColumn
.Settings.SortMode
CardViewComboBoxColumn
.Settings.SortMode
CardViewDateColumn
.Settings.SortMode
CardViewDropDownEditColumn
.Settings.SortMode
CardViewEditColumn
.Settings.SortMode
CardViewHyperLinkColumn
.Settings.SortMode
CardViewImageColumn
.Settings.SortMode
CardViewMemoColumn
.Settings.SortMode
CardViewProgressBarColumn
.Settings.SortMode
CardViewSpinEditColumn
.Settings.SortMode
CardViewTextColumn
.Settings.SortMode
CardViewTimeEditColumn
.Settings.SortMode
CardViewTokenBoxColumn
.Settings.SortMode
GridViewDataBinaryImageColumn
.Settings.SortMode
GridViewDataButtonEditColumn
.Settings.SortMode
GridViewDataCheckColumn
.Settings.SortMode
GridViewDataColorEditColumn
.Settings.SortMode
GridViewDataColumn
.Settings.SortMode
GridViewDataComboBoxColumn
.Settings.SortMode
GridViewDataDateColumn
.Settings.SortMode
GridViewDataDropDownEditColumn
.Settings.SortMode
GridViewDataHyperLinkColumn
.Settings.SortMode
GridViewDataImageColumn
.Settings.SortMode
GridViewDataMemoColumn
.Settings.SortMode
GridViewDataProgressBarColumn
.Settings.SortMode
GridViewDataSpinEditColumn
.Settings.SortMode
GridViewDataTextColumn
.Settings.SortMode
GridViewDataTimeEditColumn
.Settings.SortMode
GridViewDataTokenBoxColumn
.Settings.SortMode
GridViewEditDataColumn
.Settings.SortMode
MVCxCardViewColumn
.Settings.SortMode
MVCxGridViewColumn
.Settings.SortMode
MVCxGridViewColumn<RowType>
.Settings.SortMode
MVCxVerticalGridRow
.Settings.SortMode
MVCxVerticalGridRow<ColumnType>
.Settings.SortMode
VerticalGridBinaryImageRow
.Settings.SortMode
VerticalGridButtonEditRow
.Settings.SortMode
VerticalGridCheckRow
.Settings.SortMode
VerticalGridColorEditRow
.Settings.SortMode
VerticalGridComboBoxRow
.Settings.SortMode
VerticalGridDataRow
.Settings.SortMode
VerticalGridDateRow
.Settings.SortMode
VerticalGridDropDownEditRow
.Settings.SortMode
VerticalGridEditDataRow
.Settings.SortMode
VerticalGridHyperLinkRow
.Settings.SortMode
VerticalGridImageRow
.Settings.SortMode
VerticalGridMemoRow
.Settings.SortMode
VerticalGridProgressBarRow
.Settings.SortMode
VerticalGridSpinEditRow
.Settings.SortMode
VerticalGridTextRow
.Settings.SortMode
VerticalGridTimeEditRow
.Settings.SortMode
VerticalGridTokenBoxRow
.Settings.SortMode
ASP.NET Bootstrap Controls BootstrapCardViewBinaryImageColumn
.Settings.SortMode
BootstrapCardViewButtonEditColumn
.Settings.SortMode
BootstrapCardViewCheckColumn
.Settings.SortMode
BootstrapCardViewColorEditColumn
.Settings.SortMode
BootstrapCardViewColumn
.Settings.SortMode
BootstrapCardViewComboBoxColumn
.Settings.SortMode
BootstrapCardViewDateColumn
.Settings.SortMode
BootstrapCardViewDropDownEditColumn
.Settings.SortMode
BootstrapCardViewEditColumn
.Settings.SortMode
BootstrapCardViewHyperLinkColumn
.Settings.SortMode
BootstrapCardViewImageColumn
.Settings.SortMode
BootstrapCardViewMemoColumn
.Settings.SortMode
BootstrapCardViewProgressBarColumn
.Settings.SortMode
BootstrapCardViewSpinEditColumn
.Settings.SortMode
BootstrapCardViewTagBoxColumn
.Settings.SortMode
BootstrapCardViewTextColumn
.Settings.SortMode
BootstrapCardViewTimeEditColumn
.Settings.SortMode
BootstrapGridViewBinaryImageColumn
.Settings.SortMode
BootstrapGridViewButtonEditColumn
.Settings.SortMode
BootstrapGridViewCheckColumn
.Settings.SortMode
BootstrapGridViewColorEditColumn
.Settings.SortMode
BootstrapGridViewComboBoxColumn
.Settings.SortMode
BootstrapGridViewDataColumn
.Settings.SortMode
BootstrapGridViewDateColumn
.Settings.SortMode
BootstrapGridViewDropDownEditColumn
.Settings.SortMode
BootstrapGridViewEditDataColumn
.Settings.SortMode
BootstrapGridViewHyperLinkColumn
.Settings.SortMode
BootstrapGridViewImageColumn
.Settings.SortMode
BootstrapGridViewMemoColumn
.Settings.SortMode
BootstrapGridViewProgressBarColumn
.Settings.SortMode
BootstrapGridViewSpinEditColumn
.Settings.SortMode
BootstrapGridViewTagBoxColumn
.Settings.SortMode
BootstrapGridViewTextColumn
.Settings.SortMode
BootstrapGridViewTimeEditColumn
.Settings.SortMode

Remarks

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

Set the SortMode property to Custom and handle the following events to provide custom sorting:

Example

ASPxGridView:

<dx:ASPxGridView ID="grid">
    <SettingsBehavior AllowSort="true">
    <Columns>
        <dx:GridViewDataColumn FieldName="ContactName" SortIndex="2" SortOrder="Ascending" >
            <Settings AllowSort="false" SortMode="DisplayText" />
        </dx:GridViewDataColumn>
        ...
    </Columns>
</dx:ASPxGridView>

Concepts

ASPxGridView:

ASPxCardView:

ASPxVerticalGrid:

Online Demos

See Also