GridColumnSortInfoCollection.Insert(Int32, GridColumnSortInfo) Method

Inserts the specified GridColumnSortInfo object at the specified position.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public GridColumnSortInfo Insert(
    int position,
    GridColumnSortInfo columnInfo
)

VB.NET

Public Function Insert(
    position As Integer,
    columnInfo As GridColumnSortInfo
) As GridColumnSortInfo

Parameters

Name	Type	Description
position	Int32	A zero-based index at which to insert the specified object.
columnInfo	GridColumnSortInfo	A GridColumnSortInfo object to insert in the collection.

Returns

Type	Description
GridColumnSortInfo	The GridColumnSortInfo object added to the collection; null if the object cannot be added to the collection.

Remarks

Adding an element to the collection automatically applies sorting/grouping by the corresponding column.

This method returns null if the specified element cannot be added to the collection. See the GridColumnSortInfoCollection.Add topic for more information.

Related GitHub Examples

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

winforms-grid-always-sort-by-column/CS/Form1.cs#L54

{
    view.SortInfo.Insert(0, new GridColumnSortInfo(column, DevExpress.Data.ColumnSortOrder.Ascending));
}

VB.NET

winforms-grid-always-sort-by-column/VB/Form1.vb#L44

If column.SortOrder <> DevExpress.Data.ColumnSortOrder.Ascending OrElse column.SortIndex <> 0 Then
    view.SortInfo.Insert(0, New GridColumnSortInfo(column, DevExpress.Data.ColumnSortOrder.Ascending))
End If