BandedGridView.Bands Property

Provides access to the root band collection.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[Browsable(false)]
[XtraSerializableProperty(XtraSerializationVisibility.Collection, true, true, true, 1, XtraSerializationFlags.DefaultValue)]
[XtraSerializablePropertyId(2)]
public GridBandCollection Bands { get; }

VB.NET

<Browsable(False)>
<XtraSerializableProperty(XtraSerializationVisibility.Collection, True, True, True, 1, XtraSerializationFlags.DefaultValue)>
<XtraSerializablePropertyId(2)>
Public ReadOnly Property Bands As GridBandCollection

Property Value

Type	Description
GridBandCollection	A GridBandCollection object representing the root band collection.

Remarks

Banded Views allow you to arrange bands into a tree-like structure. The Bands property provides access to bands residing at the root hierarchy level. The GridBandCollection object returned enables you to access individual bands and rearrange them, etc. Each individual band within the collection exposes the GridBand.Children property that provides access to the band’s child bands. This property value is also represented by a GridBandCollection object. Each band within that collection can contain its own children, etc. Please refer to the Banded Grid Views topic for details on arranging bands into a tree.

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 Bands 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-display-bands-and-columns-in-the-same-tree-list-in-the-customization-form-e3723/CS/CustomDescendants/TreeListBandedCustomizationForm.cs#L79

UnvisibleList.Clear();
foreach (GridBand band in View.Bands)
{

how-to-draw-a-thick-border-around-all-column-and-band-headers-e3192/CS/Form1.cs#L36

{
    foreach (GridBand band in advBandedGridView1.Bands)
    {

VB.NET

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

UnvisibleList.Clear()
For Each band As GridBand In View.Bands
    If (Not band.Visible) AndAlso band.OptionsBand.ShowInCustomizationForm Then

how-to-draw-a-thick-border-around-all-column-and-band-headers-e3192/VB/Form1.vb#L34

Private Sub GridControl1_PaintEx(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.PaintExEventArgs)
    For Each band As GridBand In advBandedGridView1.Bands
        DrawObjectBorder(e.Cache, GetBandBounds(band))