GridColumnCollection Class

Represents a column collection in Grid Views and Card Views.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v18.1.dll

Declaration

C#

[ListBindable(false)]
public class GridColumnCollection :
    CollectionBase,
    IEnumerable<GridColumn>,
    IEnumerable

VB.NET

<ListBindable(False)>
Public Class GridColumnCollection
    Inherits CollectionBase
    Implements IEnumerable(Of GridColumn),
               IEnumerable

Related API Members

The following members accept/return GridColumnCollection objects:

• ColumnView.Columns

Remarks

Grid Views and Card Views store their columns in the ColumnView.Columns collection. This collection is represented by the GridColumnCollection class. Members of this class can be used to add, delete, access individual column objects and perform other common collection management tasks. Individual columns stored within such collections are represented by GridColumn objects. Note that you don’t have to create such objects manually. They are automatically created by the collection’s GridColumnCollection.Add and GridColumnCollection.Insert methods. You can also fill the collection with columns created for each data field within the View’s associated data source. Use the View’s ColumnView.PopulateColumns method for this purpose.

Since columns are used to represent data fields within Views, the GridColumnCollection class provides methods to obtain a particular column by its bound field name. This can be done using the collection’s indexer or via the GridColumnCollection.ColumnByFieldName method call.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GridColumnCollection class.

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#

custom-gridcontrol-how-to-create-columns-with-the-editorshowmode-property-e4356/CS/GridProject/ExtendedGridView/ExtendedGridColumnCollection.cs#L10

{
    public class ExtendedGridColumnCollection : GridColumnCollection
    {

grid-control-create-an-example-to-demonstrate-how-to-introduce-spacing-between-columns-e4254/CS/ColumnSpacing/MyGridView.cs#L16

public MyGridView(GridControl grid) : base(grid) {}
protected override GridColumnCollection CreateColumnCollection() { return new MyGridColumnCollection(this); }
protected override string ViewName { get { return "MyGridView"; } }

capability-for-a-single-column-to-fill-an-empty-space-in-a-grid-view-e2436/CS/FillEmptySpaceGridColumn/FillGridColumnCollection.cs#L6

{
    public class FillGridColumnCollection : GridColumnCollection
    {

how-to-implement-your-own-serializable-property-for-the-gridcolumn-e1951/CS/Q242361/Grid.cs#L27

protected override GridColumnCollection CreateColumnCollection() {
    return new MyGridColumnCollection(this);

how-to-add-custom-filter-items-into-the-datetime-filter-popup-window-e4265/CS/RangeDate/MyGridControl/MyGridView.cs#L23

}
protected override GridColumnCollection CreateColumnCollection()
{

VB.NET

custom-gridcontrol-how-to-create-columns-with-the-editorshowmode-property-e4356/VB/GridProject/ExtendedGridView/ExtendedGridColumnCollection.vb#L11

Public Class ExtendedGridColumnCollection
    Inherits GridColumnCollection
    Public Sub New(ByVal view As ColumnView)

grid-control-create-an-example-to-demonstrate-how-to-introduce-spacing-between-columns-e4254/VB/ColumnSpacing/MyGridView.vb#L20

End Sub
Protected Overrides Function CreateColumnCollection() As GridColumnCollection
    Return New MyGridColumnCollection(Me)

capability-for-a-single-column-to-fill-an-empty-space-in-a-grid-view-e2436/VB/FillEmptySpaceGridColumn/FillGridColumnCollection.vb#L6

Public Class FillGridColumnCollection
    Inherits GridColumnCollection

how-to-implement-your-own-serializable-property-for-the-gridcolumn-e1951/VB/Q242361/Grid.vb#L41

Protected Overrides Function CreateColumnCollection() As GridColumnCollection
    Return New MyGridColumnCollection(Me)

how-to-add-custom-filter-items-into-the-datetime-filter-popup-window-e4265/VB/RangeDate/MyGridControl/MyGridView.vb#L27

End Sub
Protected Overrides Function CreateColumnCollection() As GridColumnCollection
    Return New MyGridColumnCollection(Me)

Inheritance

Object

CollectionBase

GridColumnCollection

LayoutViewColumnCollection

BandedGridColumnCollection