CustomColumnSortEventArgs.SortOrder Property

Gets the current sort order applied to the column being processed.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public ColumnSortOrder SortOrder { get; }

VB.NET

Public ReadOnly Property SortOrder As ColumnSortOrder

Property Value

Type	Description
ColumnSortOrder	A ColumnSortOrder value representing the column’s sort order.

Available values:

Name	Description
None	No sorting is applied to a column.
Ascending	Sorts the column in ascending order.
Descending	Sorts the columns in descending order.

Remarks

The SortOrder property indicates the sort order (ascending or descending) applied to the column being processed.

When handling the GridView.CustomColumnGroup event the SortOrder property is always set to ColumnSortOrder.None.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SortOrder 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-sort-grid-columns-taking-into-account-a-hidden-column-or-field-e420/CS/WindowsApplication9/Form1.cs#L34

e.Handled = true;
if (category1 > category2 && e.SortOrder == DevExpress.Data.ColumnSortOrder.Ascending
    || category1 < category2 && e.SortOrder == DevExpress.Data.ColumnSortOrder.Descending)

how-to-put-custom-rows-in-grid-control-e3367/CS/CustomRowInGrid/CustomRowInGrid/Form1.cs#L90

{
    if (e.SortOrder == DevExpress.Data.ColumnSortOrder.Ascending)
        if (row1.ID < row2.ID)

VB.NET

how-to-sort-grid-columns-taking-into-account-a-hidden-column-or-field-e420/VB/WindowsApplication9/Form1.vb#L31

e.Handled = True
If category1 > category2 AndAlso e.SortOrder = DevExpress.Data.ColumnSortOrder.Ascending OrElse category1 < category2 AndAlso e.SortOrder = DevExpress.Data.ColumnSortOrder.Descending Then
    e.Result = 1

how-to-put-custom-rows-in-grid-control-e3367/VB/CustomRowInGrid/Form1.vb#L90

If (row1.ID < 0) AndAlso (row2.ID < 0) Then
    If e.SortOrder = DevExpress.Data.ColumnSortOrder.Ascending Then
        If row1.ID < row2.ID Then