GridControl.Columns Property

Provides access to the grid’s column collection.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.1.dll

Declaration

C#

public GridColumnCollection Columns { get; }

VB.NET

Public ReadOnly Property Columns As GridColumnCollection

Property Value

Type	Description
GridColumnCollection	A GridColumnCollection object that represents a collection of columns within the grid.

Remarks

Tip

Topics:

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

The GridControl stores its columns within the Columns collection. This collection provides methods that allow you to add new and remove existing columns. The GridColumn objects represent individual columns. Columns can be accessed using indexed notation or by the field name (ColumnBase.FieldName).

Xaml

<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="ProductName"/>
    <dxg:GridColumn FieldName="UnitPrice"/>
</dxg:GridControl.Columns> 

In Card Views, columns contained within the Columns collection correspond to card fields. In Table Views, they are displayed as columns.

Use the GridViewBase.VisibleColumns property to access only visible columns whose BaseColumn.Visible property is set to 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.

C#

masterdetail-how-to-implement-keyboard-navigation-e4054/CS/MasterDetail/MainWindow.xaml#L12

<dxg:GridControl ItemsSource="{Binding Path=DataContext.Row.Persons, RelativeSource={RelativeSource TemplatedParent}}" MaxHeight="500">
    <dxg:GridControl.Columns>
        <dxg:GridColumn FieldName="FirstName" Header="First Name" />

how-to-preserve-the-dxgrid-for-wpf-view-state-e4222/CS/SaveWpfGridState/MainWindow.xaml#L23

<dxg:GridControl x:Name="grdDetail">
    <dxg:GridControl.Columns>
        <dxg:GridColumn FieldName="id" x:Name="colidChild" Visible="False" VisibleIndex="0"/>

how-to-implement-the-master-details-functionality-with-the-servermode-enabled-e2622/CS/WpfApplication15/MainWindow.xaml#L14

<dxg:GridControl x:Name="detail" Height="200" Margin="0,3,10,3" DockPanel.Dock="Top" Visibility="Collapsed" AutoPopulateColumns="True">
    <dxg:GridControl.Columns>
        <dxg:GridColumn FieldName="ProductID" />

wpf-data-grid-disable-rows-based-on-their-values/CS/WpfApplication/MainWindow.xaml#L43

             ItemsSource="{Binding Items}">
<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="ID"/>

how-to-implement-drag-and-drop-between-gridcontrols-t566656/CS/MainWindow.xaml#L16

<dxg:GridControl Name="gridControl1">
    <dxg:GridControl.Columns>
        <dxg:GridColumn FieldName="Name" ReadOnly="True"/>

VB.NET

how-to-add-and-remove-rows-in-code/VB/AddRemoveRows/AddRemoveRowBehavior.vb#L67

Private Sub OnInitNewRow(ByVal sender As Object, ByVal e As InitNewRowEventArgs)
    AssociatedObject.Grid.SetCellValue(DataControlBase.NewItemRowHandle, AssociatedObject.Grid.Columns("ProductName"), "New Product")
    AssociatedObject.Grid.SetCellValue(DataControlBase.NewItemRowHandle, AssociatedObject.Grid.Columns("UnitPrice"), 10)

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-implement-custom-collection-that-loads-data-asynchronously-e4729/VB/AsyncDataLoading/Core/AsynchronousDataLoadingBehavior.vb#L319

Private Sub StoreColumnsProperties()
    For Each column As GridColumn In Grid.Columns
        SetGroupIndex(column, column.GroupIndex)

how-to-implement-the-columnsquickcustomization-feature-in-the-dxgrid-e3007/VB/B197981ColumnsQuickCustomization/MainWindow.xaml.vb#L38

popup.PlacementTarget = header
popup.Child = New ListBox() With {.ItemsSource = gridControl.Columns, .ItemTemplate = TryCast(FindResource("itemTemplate"), DataTemplate)}
popup.IsOpen = True

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

Dim column As GridColumn = grid.Columns("Number")
If grid.IsFilterEnabled AndAlso (Not column.IsFiltered) Then