XRSubreport Class

A Subreport control that is used to embed other reports in an XtraReport.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#
VB.NET

public class XRSubreport :
    SubreportBase

Public Class XRSubreport
    Inherits SubreportBase

Remarks

By placing an XRSubreport instance onto your report, you can embed other reports into it (via the SubreportBase.ReportSource property), e.g. to create master-detail reports, side-by-side reports or prepare templates for reusing reports or their parts (headers or footers).

Within an MDI End-User Report Designer, if an end-user double-clicks an XRSubreport control, the report assigned to it is opened in a new Design Panel of the current Designer form.

Example

This example illustrates the use of the XRSubreport control at runtime.

Not that at runtime, you can also assign a subreport by handling the XRControl.BeforePrint event of the XRSubreport control and setting its SubreportBase.ReportSource property.

C#
VB.NET

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

private void xrSubreport1_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    ((XRSubreport)sender).ReportSource = new WindowsFormsApplication1.Reports.XtraReport3();
}

Imports DevExpress.XtraReports.UI
' ...

Private Sub xrSubreport1_BeforePrint(ByVal sender As Object, _ 
ByVal e As System.Drawing.Printing.PrintEventArgs) Handles xrSubreport1.BeforePrint
    CType(sender, XRSubreport).ReportSource = New WindowsFormsApplication4.Reports.XtraReport3()
End Sub

The following example demonstrates how to create a XRSubreport control and adjust some of its main properties (e.g. SubreportBase.ReportSource). This example assumes that an XtraReport object passed as a parameter to the CreateCompositeReport method, has already been created in the current project.

Tip

Online Example: How to create an XRSubreport control

C#
VB.NET

using System.Drawing;
using DevExpress.XtraReports.UI;
// ...

public XtraReport CreateCompositeReport(XtraReport detailReport) {
    // Create a report.
    XtraReport mainReport = new XtraReport();

    // Create a subreport.
    XRSubreport subreport = new XRSubreport();

    // Create a detail band and add it to the main report.
    DetailBand detailBand = new DetailBand();
    mainReport.Bands.Add(detailBand);

    // Set the subreport's location.
    subreport.Location = new Point(110, 100);

    // Specify a detail report as a report source for the subreport.
    subreport.ReportSource = detailReport;

    // Add the subreport to the detail band.
    detailBand.Controls.Add(subreport);

    return mainReport;
}

Imports System.Drawing
Imports DevExpress.XtraReports.UI
' ...

Public Function CreateCompositeReport(ByVal detailReport As XtraReport)
    ' Create a report.
    Dim mainReport As New XtraReport()

    ' Create a subreport.
    Dim subreport As New XRSubreport()

    ' Create a detail band and add it to the main report.
    Dim detailBand As New DetailBand()
    mainReport.Bands.Add(detailBand)

    ' Set the subreport's location.
    subreport.Location = New Point(110, 100)

    ' Specify a detail report as a report source for the subreport.
    subreport.ReportSource = detailReport

    ' Add the subreport to the detail band.
    detailBand.Controls.Add(subreport)

    Return mainReport
End Function