GridColumnSortInfoCollection.Insert(Int32, GridColumn, ColumnSortOrder) Method

Creates a new GridColumnSortInfo object and inserts it at the specified position in the collection.

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,
    GridColumn column,
    ColumnSortOrder sortOrder
)

VB.NET

Public Function Insert(
    position As Integer,
    column As GridColumn,
    sortOrder As ColumnSortOrder
) As GridColumnSortInfo

Parameters

Name	Type	Description
position	Int32	A zero-based index at which to insert the specified object.
column	GridColumn	A GridColumn to initialize the GridColumnSortInfo.Column property of the newly created object.
sortOrder	ColumnSortOrder	A ColumnSortOrder value to initialize the GridColumnSortInfo.SortOrder property of the newly created object.

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.