GridBandCollection.AddBand(String) Method

Creates a band with the specified caption and appends it to the collection.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public virtual GridBand AddBand(
    string caption
)

VB.NET

Public Overridable Function AddBand(
    caption As String
) As GridBand

Parameters

Name	Type	Description
caption	String	A String value which specifies the band’s caption. This value is assigned to the GridBand.Caption property.

Returns

Type	Description
GridBand	A GridBand object which represents the created band.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddBand(String) method.

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-add-a-header-for-each-row-in-gridview-e2790/CS/WindowsApplication1/Helper/RowHeaderHelper.cs#L25

{
    GridBand band = _View.Bands.AddBand(bandCaption);
    band.Fixed = fixedStyle;

VB.NET

how-to-add-a-header-for-each-row-in-gridview-e2790/VB/Helper/RowHeaderHelper.vb#L23

Private Sub InitializeColumn(ByVal bandCaption As String, ByVal caption As String, ByVal fixedStyle As FixedStyle)
    Dim band As GridBand = _View.Bands.AddBand(bandCaption)
    band.Fixed = fixedStyle