GridControl.Columns Property

Gets a collection of the GridControl‘s columns.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public GridColumnCollection Columns { get; }

VB.NET

Public ReadOnly Property Columns As GridColumnCollection

Property Value

Type	Description
GridColumnCollection	A collection of the GridControl‘s columns.

Remarks

Tip

Topics:

• Columns and Card Fields
• Creating Columns and Binding Them to Data Properties

The GridControl stores its columns in the Columns collection. This collection’s methods allow you to add new and remove existing columns. The GridColumn objects are individual columns. You can access columns by a field name (ColumnBase.FieldName) or an index.

Xaml

<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="Full Name"/>
    <dxg:GridColumn FieldName="Birth Date"/>
</dxg:GridControl.Columns> 

The Table View displays Columns collection’s items as columns. The Card View — as card fields.

Use the GridViewBase.VisibleColumns property to access only visible columns (the BaseColumn.Visible property value is true).

Related GitHub Examples

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

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.

XAML

wpf-data-grid-process-frequent-data-updates/CS/ChunkAndOptSummariesExample/MainWindow.xaml#L25

</dxg:GridControl.GroupSummary>
<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="Name"/>

wpf-data-grid-display-icon-in-unbound-column-based-on-value-in-bound-column/CS/UnboundColumnWithIcons_CodeBehind/Window1.xaml#L17

             CustomUnboundColumnData="GridControl_CustomUnboundColumnData">
<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="Action" />

wpf-data-grid-implement-custom-grouping/CS/CustomGrouping_CodeBehind/MainWindow.xaml#L12

             CustomGroupDisplayText="OnCustomGroupDisplayText">
<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="FirstName" />

wpf-data-grid-validate-cell-editors/CS/ValidateCell_CodeBehind/MainWindow.xaml#L13

<dxg:GridControl x:Name="grid">
    <dxg:GridControl.Columns>
        <dxg:GridColumn FieldName="ProductName">

wpf-data-grid-implement-custom-sorting/CS/CustomSorting_CodeBehind/MainWindow.xaml#L10

             CustomColumnSort="OnCustomColumnSort">
<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="Day" GroupIndex="0" SortMode="Custom"/>

C#

wpf-data-grid-create-event-raised-on-layout-changes/CS/E4609/Implementation/GridLayoutHelper.cs#L22

base.OnAttached();
SubscribeColumns(Grid.Columns);
Grid.Columns.CollectionChanged += ColumnsCollectionChanged;

how-to-initialize-a-new-row-when-only-the-editor-is-shown-e1817/CS/InitNewRow_Editing/InitNewRowOnEditingBehavior.cs#L29

void OnInitNewRow(object sender, InitNewRowEventArgs e) {
    AssociatedObject.Grid.SetCellValue(GridControl.NewItemRowHandle, AssociatedObject.Grid.Columns["Text"], "New Row");
    AssociatedObject.Grid.SetCellValue(GridControl.NewItemRowHandle, AssociatedObject.Grid.Columns["Number"], 999997);

how-to-show-images-in-a-column-filter-drop-down-window-e3941/CS/Default MVVM/FilterPopupConverter.cs#L48

GridColumn column = grid.Columns["Number"];
if (grid.IsFilterEnabled && !column.IsFiltered)

how-to-create-search-window-with-find-previous-and-find-next-buttons-in-gridcontrol-t127527/CS/DevExpress.Example01/SearchBehavior/SearchWindow.xaml.cs#L209

foreach(var rowHandle in rowHandles) {
    foreach(var col in this._Grid.Columns) {
        var cellText = this._Grid.GetCellDisplayText(rowHandle, col).ToLower();

how-to-use-scrollbar-annotations-t534664/CS/WpfApplication25/MainWindow.xaml.cs#L54

    view.SearchString = "Element2";
    view.SelectCells(15, view.Grid.Columns[0], 25, view.Grid.Columns[1]);
}

VB.NET

wpf-data-grid-create-event-raised-on-layout-changes/VB/E4609/Implementation/GridLayoutHelper.vb#L24

MyBase.OnAttached()
SubscribeColumns(Grid.Columns)
AddHandler Grid.Columns.CollectionChanged, AddressOf ColumnsCollectionChanged

how-to-initialize-a-new-row-when-only-the-editor-is-shown-e1817/VB/InitNewRow_Editing/InitNewRowOnEditingBehavior.vb#L32

Private Sub OnInitNewRow(ByVal sender As Object, ByVal e As InitNewRowEventArgs)
    AssociatedObject.Grid.SetCellValue(DataControlBase.NewItemRowHandle, AssociatedObject.Grid.Columns("Text"), "New Row")
    AssociatedObject.Grid.SetCellValue(DataControlBase.NewItemRowHandle, AssociatedObject.Grid.Columns("Number"), 999997)

how-to-show-images-in-a-column-filter-drop-down-window-e3941/VB/Default MVVM/FilterPopupConverter.vb#L41

If source IsNot Nothing AndAlso source.Count > 0 Then
    Dim column As GridColumn = grid.Columns("Number")
    If grid.IsFilterEnabled AndAlso Not column.IsFiltered Then

how-to-create-search-window-with-find-previous-and-find-next-buttons-in-gridcontrol-t127527/VB/DevExpress.Example01/SearchBehavior/SearchWindow.xaml.vb#L200

For Each rowHandle In rowHandles
    For Each col In _Grid.Columns
        Dim cellText = _Grid.GetCellDisplayText(rowHandle, col).ToLower()

how-to-use-scrollbar-annotations-t534664/VB/WpfApplication25/MainWindow.xaml.vb#L45

    view.SearchString = "Element2"
    view.SelectCells(15, view.Grid.Columns(0), 25, view.Grid.Columns(1))
End Sub