BandedGridView.Columns Property

Provides access to the column collection.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[Browsable(false)]
[XtraSerializableProperty(XtraSerializationVisibility.Collection, true, true, true, 0, XtraSerializationFlags.DefaultValue)]
[XtraSerializablePropertyId(2)]
public BandedGridColumnCollection Columns { get; }

VB.NET

<Browsable(False)>
<XtraSerializableProperty(XtraSerializationVisibility.Collection, True, True, True, 0, XtraSerializationFlags.DefaultValue)>
<XtraSerializablePropertyId(2)>
Public ReadOnly Property Columns As BandedGridColumnCollection

Property Value

Type	Description
BandedGridColumnCollection	A BandedGridColumnCollection object representing the View’s column collection.

Remarks

Use the Columns property to access an object that manages the View’s columns. You can use this property as an indexer to access columns by their indexes or bound field names. The GridBandColumnCollection.Add and GridBandColumnCollection.Remove methods enable you to add new or delete existing columns.

The Columns property overrides the ColumnView.Columns property since Banded Grid Views use BandedGridColumn objects to represent their columns. Please refer to the Columns topic for details.

Example

This example shows how to create a GridControl, while presenting its underlying data using a banded grid format (BandedGridView). The example creates three bands (Main, Address and Phone), adds columns to the bands and customizes the background color for the third band and its columns.

C#

using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Views.BandedGrid;

GridControl gridControl1 = new GridControl();
gridControl1.Parent = this;
gridControl1.Dock = DockStyle.Fill;

BandedGridView bandedGridView1 = new BandedGridView(gridControl1);
GridBand gridBandMain = new GridBand();
GridBand gridBandAddress = new GridBand();
GridBand gridBandPhone = new GridBand();
BandedGridColumn colCity = new BandedGridColumn();
BandedGridColumn colCompanyName = new BandedGridColumn();
BandedGridColumn colContactName = new BandedGridColumn();
BandedGridColumn colCountry = new BandedGridColumn();
BandedGridColumn colPhone = new BandedGridColumn();
BandedGridColumn colFax = new BandedGridColumn();

gridControl1.DataSource = this.customersBindingSource;
gridControl1.ViewCollection.Add(bandedGridView1);
gridControl1.MainView = bandedGridView1;

bandedGridView1.Bands.AddRange(new GridBand[] {gridBandMain,gridBandAddress,gridBandPhone});
bandedGridView1.Columns.AddRange(new BandedGridColumn[] {colCompanyName,colContactName,colCity,colCountry,colPhone,colFax});

colCompanyName.FieldName = "CompanyName";
colCompanyName.Visible = true;
colCompanyName.Width = 94;

colContactName.FieldName = "ContactName";
colContactName.Visible = true;
colContactName.Width = 74;

colCountry.FieldName = "Country";
colCountry.Visible = true;
colCountry.Width = 67;

colCity.FieldName = "City";
colCity.Visible = true;
colCity.Width = 57;

colPhone.AppearanceCell.BackColor = System.Drawing.Color.PowderBlue;
colPhone.AppearanceCell.Options.UseBackColor = true;
colPhone.AppearanceHeader.BackColor = System.Drawing.Color.PowderBlue;
colPhone.AppearanceHeader.Options.UseBackColor = true;
colPhone.FieldName = "Phone";
colPhone.Visible = true;
colPhone.Width = 81;

colFax.AppearanceCell.BackColor = System.Drawing.Color.PowderBlue;
colFax.AppearanceCell.Options.UseBackColor = true;
colFax.AppearanceHeader.BackColor = System.Drawing.Color.PowderBlue;
colFax.AppearanceHeader.Options.UseBackColor = true;
colFax.FieldName = "Fax";
colFax.Visible = true;
colFax.Width = 84;

gridBandMain.Caption = "Main";
gridBandMain.Columns.Add(colCompanyName);
gridBandMain.Columns.Add(colContactName);
gridBandMain.VisibleIndex = 0;
gridBandMain.Width = 168;

gridBandAddress.Caption = "Address";
gridBandAddress.Columns.Add(colCountry);
gridBandAddress.Columns.Add(colCity);
gridBandAddress.VisibleIndex = 1;
gridBandAddress.Width = 124;

gridBandPhone.AppearanceHeader.BackColor = System.Drawing.Color.LightBlue;
gridBandPhone.AppearanceHeader.Options.UseBackColor = true;
gridBandPhone.Caption = "Phone";
gridBandPhone.Columns.Add(colPhone);
gridBandPhone.Columns.Add(colFax);
gridBandPhone.VisibleIndex = 2;
gridBandPhone.Width = 165;

bandedGridView1.OptionsCustomization.AllowChangeColumnParent = false;

VB.NET

Imports DevExpress.XtraGrid
Imports DevExpress.XtraGrid.Views.BandedGrid

Dim gridControl1 As GridControl = New GridControl()
gridControl1.Parent = Me
gridControl1.Dock = DockStyle.Fill

Dim bandedGridView1 As BandedGridView = New BandedGridView(gridControl1)
Dim gridBandMain As GridBand = New GridBand()
Dim gridBandAddress As GridBand = New GridBand()
Dim gridBandPhone As GridBand = New GridBand()
Dim colCity As BandedGridColumn = New BandedGridColumn()
Dim colCompanyName As BandedGridColumn = New BandedGridColumn()
Dim colContactName As BandedGridColumn = New BandedGridColumn()
Dim colCountry As BandedGridColumn = New BandedGridColumn()
Dim colPhone As BandedGridColumn = New BandedGridColumn()
Dim colFax As BandedGridColumn = New BandedGridColumn()

gridControl1.DataSource = customersBindingSource
gridControl1.ViewCollection.Add(bandedGridView1)
gridControl1.MainView = bandedGridView1

bandedGridView1.Bands.AddRange(New GridBand() {gridBandMain, gridBandAddress, gridBandPhone})
bandedGridView1.Columns.AddRange(New BandedGridColumn() {colCompanyName, colContactName, colCity, colCountry, colPhone, colFax})

colCompanyName.FieldName = "CompanyName"
colCompanyName.Visible = True
colCompanyName.Width = 94

colContactName.FieldName = "ContactName"
colContactName.Visible = True
colContactName.Width = 74

colCountry.FieldName = "Country"
colCountry.Visible = True
colCountry.Width = 67

colCity.FieldName = "City"
colCity.Visible = True
colCity.Width = 57

colPhone.AppearanceCell.BackColor = Color.PowderBlue
colPhone.AppearanceCell.Options.UseBackColor = True
colPhone.AppearanceHeader.BackColor = Color.PowderBlue
colPhone.AppearanceHeader.Options.UseBackColor = True
colPhone.FieldName = "Phone"
colPhone.Visible = True
colPhone.Width = 81

colFax.AppearanceCell.BackColor = Color.PowderBlue
colFax.AppearanceCell.Options.UseBackColor = True
colFax.AppearanceHeader.BackColor = Color.PowderBlue
colFax.AppearanceHeader.Options.UseBackColor = True
colFax.FieldName = "Fax"
colFax.Visible = True
colFax.Width = 84

gridBandMain.Caption = "Main"
gridBandMain.Columns.Add(colCompanyName)
gridBandMain.Columns.Add(colContactName)
gridBandMain.VisibleIndex = 0
gridBandMain.Width = 168

gridBandAddress.Caption = "Address"
gridBandAddress.Columns.Add(colCountry)
gridBandAddress.Columns.Add(colCity)
gridBandAddress.VisibleIndex = 1
gridBandAddress.Width = 124

gridBandPhone.AppearanceHeader.BackColor = Color.LightBlue
gridBandPhone.AppearanceHeader.Options.UseBackColor = True
gridBandPhone.Caption = "Phone"
gridBandPhone.Columns.Add(colPhone)
gridBandPhone.Columns.Add(colFax)
gridBandPhone.VisibleIndex = 2
gridBandPhone.Width = 165

bandedGridView1.OptionsCustomization.AllowChangeColumnParent = False

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#

how-to-show-multiple-group-summary-items-in-the-same-group-footer-cell-in-bandedgridview-e4900/CS/Form1.cs#L26

private void BandColumns() {
    gridBand2.Columns.Add(myBandedGridView1.Columns["Date"]);
    gridBand2.Columns.Add(myBandedGridView1.Columns["String"]);

how-to-display-bands-and-columns-in-the-same-tree-list-in-the-customization-form-e3723/CS/CustomDescendants/TreeListBandedCustomizationForm.cs#L87

}
foreach (GridColumn column in View.Columns)
{

VB.NET

how-to-show-multiple-group-summary-items-in-the-same-group-footer-cell-in-bandedgridview-e4900/VB/Form1.vb#L28

Private Sub BandColumns()
    gridBand2.Columns.Add(myBandedGridView1.Columns("Date"))
    gridBand2.Columns.Add(myBandedGridView1.Columns("String"))

how-to-display-bands-and-columns-in-the-same-tree-list-in-the-customization-form-e3723/VB/CustomDescendants/TreeListBandedCustomizationForm.vb#L92

Next band
For Each column As GridColumn In View.Columns
    If column.CanShowInCustomizationForm Then