BandedGridColumn Class

Represents an individual column in Banded Grid Views.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v17.2.dll

Declaration

C#

public class BandedGridColumn :
    GridColumn

VB.NET

Public Class BandedGridColumn
    Inherits GridColumn

Related API Members

The following members accept/return BandedGridColumn objects:

• BandedGridColumnCollection.Add()
• BandedGridColumnCollection.AddField(String)
• BandedGridColumnCollection.ColumnByFieldName(String)
• BandedGridColumnCollection.ColumnByName(String)
• BandedGridColumnCollection.Item[Int32]
• BandedGridColumnCollection.Item[String]
• BandedGridColumnReadOnlyCollection.Item[Int32]
• BandedGridHitInfo.Column
• GridBandColumnCollection.Item[Int32]
• GridBandColumnCollection.Item[String]

Remarks

BandedGridColumn objects represent individual columns displayed in Banded Grid Views and Advanced Banded Grid Views. Both View types arrange columns into bands. So, the BandedGridColumn class introduces members used to bind columns to bands. Advanced Banded Grid Views allow custom column arrangement. Thus, the BandedGridColumn class introduces properties controlling column header and cell position and size. These are the BandedGridColumn.ColIndex, BandedGridColumn.RowIndex, BandedGridColumn.AutoFillDown and BandedGridColumn.RowCount properties. Note that these settings are not in effect for columns owned by a BandedGridView.

To display a column within a specific band in code, first assign the required band to the column’s BandedGridColumn.OwnerBand property. Then, specify the position of the column within the band. For BandedGridViews, use the GridBandColumnCollection.MoveTo method of the GridBand.Columns collection. For AdvBandedGridViews, call the AdvBandedGridView.SetColumnPosition method.

To temporarily hide a column from the View, use the GridColumn.Visible inherited property.

Available BandedGridColumn objects can be accessed via the BandedGridView.Columns property. To access columns owned by a specific band, use the band’s GridBand.Columns property.

Related GitHub Examples

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

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/MyGridCtrl/MyBandedGridView.cs#L31

}
private Dictionary<BandedGridColumn, int> GetFooterRowCount() {
    var columnFooterRowCount = new Dictionary<BandedGridColumn, int>();

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

BandedGridColumn gridColumn = e.Node[0] as BandedGridColumn;
if (gridColumn != null && (!gridColumn.Visible || gridColumn.OwnerBand == null)) DrawNodeElementAsColumn(e);

how-to-create-an-advbandedgridview-descendant-allows-using-repositoryitems-to-display-edit-r-e5014/CS/GridView_RowPreview/Form1.cs#L35

customGridControl1.DataSource = myUsers;
BandedGridColumn gridColumn1 = new BandedGridColumn();
BandedGridColumn gridColumn2 = new BandedGridColumn();

how-to-select-cells-under-by-clicking-the-gridband-or-the-column-header-e490/CS/Q130069/Form1.cs#L55

private void SelectCells(BandedGridColumn column)
{

bandedgridview-how-to-hide-particular-bands-e3175/CS/BandedGridViewHideBands/MyPaintHelper.cs#L39

foreach (GridBand band in _Bands)
    foreach (BandedGridColumn column in band.Columns)
        DrawColumnHeader(e.Cache, column);

VB.NET

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

Dim gridColumn As BandedGridColumn = TryCast(e.Node(0), BandedGridColumn)
If gridColumn IsNot Nothing AndAlso ((Not gridColumn.Visible) OrElse gridColumn.OwnerBand Is Nothing) Then

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

End Function
Private Function GetFooterRowCount() As Dictionary(Of BandedGridColumn, Integer)
    Dim columnFooterRowCount = New Dictionary(Of BandedGridColumn, Integer)()

how-to-create-an-advbandedgridview-descendant-allows-using-repositoryitems-to-display-edit-r-e5014/VB/Form1.vb#L33

customGridControl1.DataSource = myUsers
Dim gridColumn1 As New BandedGridColumn()
Dim gridColumn2 As New BandedGridColumn()

how-to-select-cells-under-by-clicking-the-gridband-or-the-column-header-e490/VB/Q130069/Form1.vb#L51

Private Sub SelectCells(ByVal column As BandedGridColumn)
    For i As Integer = 0 To column.View.RowCount - 1

bandedgridview-how-to-hide-particular-bands-e3175/VB/BandedGridViewHideBands/MyPaintHelper.vb#L40

For Each band As GridBand In _Bands
    For Each column As BandedGridColumn In band.Columns
        DrawColumnHeader(e.Cache, column)

Inheritance

Object

MarshalByRefObject

Component

GridColumn

BandedGridColumn