BandCollection.Add(Band) Method

Overrides the XRControlCollection.Add method.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Core

Declaration

C#

public int Add(
    Band band
)

VB.NET

Public Function Add(
    band As Band
) As Integer

Parameters

Name	Type	Description
band	Band	A Band object to add to the collection of bands.

Returns

Type	Description
Int32	An integer value indicating the position into which the new band was inserted.

Remarks

This method is intended to allow only Band objects to be added to the collection of bands.

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#

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);
    }

}

VB.NET

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#

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();
}

VB.NET

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(Band) 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#

Reporting_how-to-create-a-report-based-on-hierarchical-data-e1741/CS/Form1.cs#L88

detailBand.Height = 25;
detailReport.Bands.Add(detailBand);
parentReport.Bands.Add(detailReport);

asp-net-mvc-grid-create-report-based-on-grid-layout/CS/E4755/Models/ReportHelperMVC.cs#L44

if (gridViewState.TotalSummary.Count > 0) {
    report.Bands.Add(new ReportFooterBand() {
        HeightF = bandHeight

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/CS/DXGridSample/ReportHelper.cs#L43

if (grid.TotalSummary.Count > 0) {
    report.Bands.Add(new ReportFooterBand() { HeightF = bandHeight });
    foreach (GridSummaryItem item in grid.TotalSummary) {

reporting-wpf-create-report-in-code/CS/RuntimeReportsApplication/MainWindow.xaml.cs#L81

ReportHeaderBand reportHeader = new ReportHeaderBand();
report.Bands.Add(reportHeader);
reportHeader.Controls.Add(label);

Reporting_how-to-create-an-xrsubreport-control-e103/CS/Form1.cs#L21

DetailBand detailBand = new DetailBand();
mainReport.Bands.Add(detailBand);

VB.NET

Reporting_how-to-create-a-report-based-on-hierarchical-data-e1741/VB/Form1.vb#L50

headerBand.Controls.Add(title)
report.Bands.Add(headerBand)
report.Bands.Add(detailBand)

asp-net-mvc-grid-create-report-based-on-grid-layout/VB/E4755/Models/ReportHelperMVC.vb#L45

If gridViewState.TotalSummary.Count > 0 Then
    report.Bands.Add(New ReportFooterBand() With {.HeightF = bandHeight})
    For Each item As MVCxSummaryItemState In gridViewState.TotalSummary

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/VB/DXGridSample/ReportHelper.vb#L43

If grid.TotalSummary.Count > 0 Then
    report.Bands.Add(New ReportFooterBand() With {.HeightF = bandHeight})
    For Each item As GridSummaryItem In grid.TotalSummary

reporting-wpf-create-report-in-code/VB/RuntimeReportsApplication/MainWindow.xaml.vb#L74

Dim reportHeader As ReportHeaderBand = New ReportHeaderBand()
report.Bands.Add(reportHeader)
reportHeader.Controls.Add(label)

Reporting_how-to-create-an-xrsubreport-control-e103/VB/Form1.vb#L23

Dim detailBand As New DetailBand()
mainReport.Bands.Add(detailBand)