BandCollection Class

A collection of Band objects.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#
VB.NET

public class BandCollection :
    XRControlCollection,
    IEnumerable<Band>,
    IEnumerable

Public Class BandCollection
    Inherits XRControlCollection
    Implements IEnumerable(Of Band),
               IEnumerable

The following members return BandCollection objects:

Remarks

Use the BandCollection.Add and BandCollection.Remove methods to add or remove individual bands from the collection. You can also determine if a band is a member of the collection by passing the band to the BandCollection.Contains method. To get the index value of the band in the collection, pass this band to the BandCollection.IndexOf method.

Example

The following example demonstrates how to use the basic methods of the BandCollection class to construct a simple report. The first method (AddMarginBands) creates two margin bands, and adds them to the report’s collection of bands. The second method (RemoveMarginBands) removes margin bands from the collection.

Tip

Online Example: How to programmatically manage report bands

C#
VB.NET

using DevExpress.XtraPrinting;
using DevExpress.XtraReports.UI;
// ...

public class XtraReport1 : DevExpress.XtraReports.UI.XtraReport {
// ...

    // ...
    // Generated code for the XtraReport1 class.
    // ...

    public void AddMarginBands() {

        // Check if the TopMargin band is already present in the report.
        if(Bands.GetBandByType(typeof(TopMarginBand)) == null) {
            // Create a new TopMargin band and add it to the report.
            TopMarginBand tmBand = new TopMarginBand();
            Bands.Add(tmBand);

            // Create a label and set its text and width.
            XRLabel label = new XRLabel();
            label.Text = "TopMargin Band";
            label.Width = 200;

            // Add the label to the TopMargin band.
            tmBand.Controls.Add(label);
        }

        // Check if the BottomMargin band is already present in the report.
        if(Bands.GetBandByType(typeof(BottomMarginBand)) == null) {
            // Create a new BottomMargin band and add it to the report.
            BottomMarginBand bmBand = new BottomMarginBand();
            Bands.Add(bmBand);

            // Create an XRPageInfo object and set its width and PageInfo option.
            XRPageInfo datePageInfo = new XRPageInfo();
            datePageInfo.Width = 200;
            datePageInfo.PageInfo = PageInfo.DateTime;

            // Add the page information control to the BottomMargin band.
            bmBand.Controls.Add(datePageInfo);
        }
    }


    public void RemoveMarginBands() {
        // Obtain the TopMargin band and remove it from the report.
        Band band = Bands.GetBandByType(typeof(TopMarginBand));
        if(band != null) Bands.Remove(band);

        // Obtain the BottomMargin band and remove it from the report.
        band = Bands.GetBandByType(typeof(BottomMarginBand));
        if(band != null) Bands.Remove(band);
    }

}

Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.UI
' ...

Public Class XtraReport1
    Inherits DevExpress.XtraReports.UI.XtraReport
    ' ...

    ' ...
    ' Generated code for the XtraReport1 class.
    ' ...

    Public Sub AddMarginBands()

        ' Check if the TopMargin band is already present in the report.
        If Bands.GetBandByType(GetType(TopMarginBand)) Is Nothing Then
            ' Create a new TopMargin band and add it to the report.
            Dim tmBand As New TopMarginBand()
            Bands.Add(tmBand)

            ' Create a label and set its text and width.
            Dim label As New XRLabel()
            label.Text = "TopMargin Band"
            label.Width = 200

            ' Add the label to the TopMargin band.
            tmBand.Controls.Add(label)
        End If

        ' Check if the BottomMargin band is already present in the report.
        If Bands.GetBandByType(GetType(BottomMarginBand)) Is Nothing Then
            ' Create a new BottomMargin band and add it to the report.
            Dim bmBand As New BottomMarginBand()
            Bands.Add(bmBand)

            ' Create an XRPageInfo object and set its width and PageInfo option.
            Dim datePageInfo As New XRPageInfo()
            datePageInfo.Width = 200
            datePageInfo.PageInfo = PageInfo.DateTime

            ' Add the page information control to the BottomMargin band.
            bmBand.Controls.Add(datePageInfo)
        End If
    End Sub


    Public Sub RemoveMarginBands()
        ' Obtain the TopMargin band and remove it from the report.
        Dim band As Band = Bands.GetBandByType(GetType(TopMarginBand))
        If Not (band Is Nothing) Then
            Bands.Remove(band)
        End If

        ' Obtain the BottomMargin band and remove it from the report.
        band = Bands.GetBandByType(GetType(BottomMarginBand))
        If Not (band Is Nothing) Then
            Bands.Remove(band)
        End If
    End Sub

End Class

And, the following code should be used to call these two methods:

C#
VB.NET

XtraReport1 report = new XtraReport1();

private void btnPreview_Click(object sender, System.EventArgs e) {
    ReportPrintTool preview = new ReportPrintTool(report);
    preview.ShowPreview();
}

private void btnAddBands_Click(object sender, System.EventArgs e) {
    report.AddMarginBands();
}

private void btnRemoveBands_Click(object sender, System.EventArgs e) {
    report.RemoveMarginBands();
}

Dim Report As New XtraReport1()

Private Sub BtnPreview_Click(sender As Object, e As System.EventArgs) _
Handles BtnPreview.Click
    Dim preview As New ReportPrintTool(report)
    preview.ShowPreview()
End Sub

Private Sub BtnAddBands_Click(sender As Object, e As System.EventArgs) _
Handles BtnAddBands.Click
    Report.AddMarginBands()
End Sub

Private Sub BtnRemoveBands_Click(sender As Object, e As System.EventArgs) _
Handles BtnRemoveBands.Click
    Report.RemoveMarginBands()
End Sub