GridColumnSortInfoCollection.Add(GridColumn, ColumnSortOrder) Method

Adds a new GridColumnSortInfo item to the collection.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

public GridColumnSortInfo Add(
    GridColumn column,
    ColumnSortOrder sortOrder
)
Public Function Add(
    column As GridColumn,
    sortOrder As ColumnSortOrder
) As GridColumnSortInfo

Parameters

Name Type Description
column GridColumn

A GridColumn object which will be sorted using the specified sort order. This parameter's value is used to initialize the GridColumnSortInfo.Column property.

sortOrder ColumnSortOrder

A ColumnSortOrder value specifying the sort order for the column. This parameter's value is used to initialize the GridColumnSortInfo.SortOrder property.

Returns

Type Description
GridColumnSortInfo

A GridColumnSortInfo object representing the new element in the collection; null if the object cannot be added to the collection.

Remarks

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

This method returns null if the specified element cannot be added to the collection. This can occur for several reasons:

  • the grid's View doesn't support grouping and the specified column is being inserted as a grouping column (at a position less than the GridColumnSortInfoCollection.GroupCount);
  • the specified column doesn't support sorting and therefore grouping (for instance, the columns which display image or memo data);
  • another element which refers to the specified column is already present in the current collection.
See Also