GridView.CanSortColumn(GridColumn) Method

Indicates whether end-users can sort data by values of a particular column.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public override bool CanSortColumn(
    GridColumn column
)

VB.NET

Public Overrides Function CanSortColumn(
    column As GridColumn
) As Boolean

Parameters

Name	Type	Description
column	GridColumn	A GridColumn object (or descendant) representing the tested column.

Returns

Type	Description
Boolean	true if end-users can sort data by the specified column’s values; otherwise, false.

Remarks

This member supports the grid control’s internal infrastructure and is not intended to be used in your code.

The CanSortColumn method returns true if the following conditions are met:

• The specified column’s data type allows sorting.
• The View’s GridOptionsCustomization.AllowSort option and the column’s OptionsColumn.AllowSort options are enabled.

Views use the CanSortColumn method to determine whether clicks on column headers result in sorting data. Additionally, the CanSortColumn method’s return value specifies whether sorting can be applied using the column header context menu.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CanSortColumn(GridColumn) method.

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-introduce-the-ability-to-drag-columns-between-grids-e2197/CS/MyGridView.cs#L26

        return true;
    return base.CanSortColumn(column);
}

VB.NET

how-to-introduce-the-ability-to-drag-columns-between-grids-e2197/VB/MyGridView.vb#L35

    End If
    Return MyBase.CanSortColumn(column)
End Function