GridColumnSortInfoCollection.Add(GridColumnSortInfo) Method

Adds the specified GridColumnSortInfo object to the collection.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

public GridColumnSortInfo Add(
    GridColumnSortInfo columnInfo
)
Public Function Add(
    columnInfo As GridColumnSortInfo
) As GridColumnSortInfo

Parameters

Name Type Description
columnInfo GridColumnSortInfo

A GridColumnSortInfo object to add to the collection.

Returns

Type Description
GridColumnSortInfo

The GridColumnSortInfo object that has been added to 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