XtraReportBase.Bands Property
Gets the collection of bands contained in a report.
Namespace: DevExpress.XtraReports.UI
Assembly: DevExpress.XtraReports.v19.1.dll
NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Core
Declaration
Property Value
| Type | Description |
|---|---|
| BandCollection | A BandCollection object that is the collection of bands contained in a report. |
Remarks
To learn more about the bands used in reports see the First Look at the Report Designer topic.
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
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);
}
}
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);
preview.ShowPreview();
}
private void btnAddBands_Click(object sender, System.EventArgs e) {
report.AddMarginBands();
}
private void btnRemoveBands_Click(object sender, System.EventArgs e) {
report.RemoveMarginBands();
}
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the Bands property.
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.