DataViewBase.ColumnChooserColumns Property

Gets a collection of hidden columns displayed in the Column Chooser. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v20.2.Core.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, DevExpress.Wpf.Grid.Core

Declaration

C#

[Browsable(false)]
public ReadOnlyCollection<ColumnBase> ColumnChooserColumns { get; protected set; }

VB.NET

<Browsable(False)>
Public Property ColumnChooserColumns As ReadOnlyCollection(Of ColumnBase)

Property Value

Type	Description
ReadOnlyCollection<ColumnBase>	A collection of hidden columns displayed in the Column Chooser.

Remarks

The ColumnChooserColumns collection stores columns if their BaseColumn.Visible property is set to false, and their ColumnBase.ShowInColumnChooser property is set to true.

The following code sample creates a ListBoxEdit and binds it to the ColumnChooserColumns collection:

XAML

<dxg:GridControl Name="grid">
  <dxg:GridControl.View>
      <dxg:TableView Name="view" ... />
      <dxg:GridControl.Columns>
          <dxg:GridColumn FieldName="Name"/>
          <dxg:GridColumn FieldName="City"/>
          <dxg:GridColumn FieldName="Visits" Visible="False"/>
          <dxg:GridColumn FieldName="Birthday" Visible="False" ShowInColumnChooser="False"/>
      </dxg:GridControl.Columns>
</dxg:GridControl>
<GroupBox Header="Column Chooser Columns">
    <dxe:ListBoxEdit ItemsSource="{Binding ColumnChooserColumns, ElementName=view}" 
                     DisplayMember="FieldName"/>
</GroupBox>

Refer to the Show and Hide Columns topic for more information.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ColumnChooserColumns 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

how-to-create-a-custom-columnchooser-that-allows-arranging-columns-by-dragdrop-e3368/CS/MainWindow.xaml#L122

<Border Grid.Row="1" Grid.Column="2" BorderBrush="#FF4D0A9C" BorderThickness="1">
    <local:ColumnList x:Name="ColumnChooserList" IsHitTestVisible="True" Columns="{Binding Path=View.ColumnChooserColumns, RelativeSource={RelativeSource TemplatedParent}}">
        <dx:DragManager.DropTargetFactory>

C#

how-to-create-a-custom-columnchooser-that-allows-arranging-columns-by-dragdrop-e3368/CS/MainWindow.xaml.cs#L116

View.DataControl.BeginDataUpdate();
foreach(GridColumn column in ((GridViewBase)View).ColumnChooserColumns) {
    column.Visible = true;

VB.NET

how-to-create-a-custom-columnchooser-that-allows-arranging-columns-by-dragdrop-e3368/VB/MainWindow.xaml.vb#L123

View.DataControl.BeginDataUpdate()
For Each column As GridColumn In CType(View, GridViewBase).ColumnChooserColumns
    column.Visible = True