IModelColumn.SortIndex Property

Specifies the sequence of column sorting.

Namespace: DevExpress.ExpressApp.Model

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

C#

[DefaultValue(-1)]
int SortIndex { get; set; }

VB.NET

<DefaultValue(-1)>
Property SortIndex As Integer

Property Value

Type	Default	Description
Int32	-1	An integer value specifying the sequence of column sorting.

Remarks

List View records can be sorted by multiple columns. The SortIndex value is zero-based. It means that initially, List View records are sorted by the column with the zero SortIndex value, second - by the column with SortIndex set to 1, etc. The -1 value cancels data sorting by this column. When it is required to sort a List View by the single column, this column’s SortIndex should be zero. Note that by default, if the SortIndex property value does not equal -1, the Ascending sorting is applied (IModelColumn.SortOrder is set to ColumnSortOrder.Ascending). So, to disable sorting, you must set SortIndex to -1 and SortOrder to None.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SortIndex 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#

XAF_how-to-sort-a-listview-in-code-e1276/CS/WinWebSolution.Module/SortListViewController.cs#L24

if (columnInfo != null) {
    columnInfo.SortIndex = 0;
    columnInfo.SortOrder = ColumnSortOrder.Descending;

VB.NET

XAF_how-to-sort-a-listview-in-code-e1276/VB/WinWebSolution.Module/SortListViewController.vb#L26

If columnInfo IsNot Nothing Then
    columnInfo.SortIndex = 0
    columnInfo.SortOrder = ColumnSortOrder.Descending