The requested page is not available for the requested platform. You are viewing the content for Default platform.

BandCollection.Add(Band) Method

Overrides the XRControlCollection.Add method.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.2.dll


public int Add(
    Band band
Public Function Add(
    band As Band
) As Integer


Name Type Description
band Band

A Band object to add to the collection of bands.


Type Description

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


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


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.

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

            // 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.

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

            // 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.

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


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

XtraReport1 report = new XtraReport1();

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

private void btnAddBands_Click(object sender, System.EventArgs e) {

private void btnRemoveBands_Click(object sender, System.EventArgs e) {
See Also