SubreportBase.ReportSource Property

Gets or sets an XtraReport class instance. The instance’s content is included in the main report.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

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

Declaration

C#

[SRCategory(ReportStringId.CatData)]
public XtraReport ReportSource { get; set; }

VB.NET

<SRCategory(ReportStringId.CatData)>
Public Property ReportSource As XtraReport

Property Value

Type	Description
XtraReport	An XtraReport class instance.

Remarks

Rebuild the solution at design time after you declare an XtraReport class to be able to reference this class in the XRSubreport‘s ReportSource property.

Note

The ReportSource property is not available in Web Report Designer.

Use the ReportSourceUrl property instead of ReportSource to reference a report that is stored in a report definition (REPX) or XML file.

The ReportSourceUrl property value takes precedence over the ReportSource value. If you specify both properties, the XRSubreport includes the content from the report specified by ReportSourceUrl.

See XRSubreport for more information.

Examples

The code sample below adds an XRSubreport item to the report and uses the ReportSource property to reference a detail report.

Tip

Online Example: Use Subreports to Add a Chart

C#

using System.IO;
using System.Drawing;
using DevExpress.XtraReports.UI;
// ...
XRSubreport subreport = new XRSubreport() {
    BoundsF = new RectangleF(0, 100, 550, 25),
};
// "mainReport" is an XtraReport instance.
// Add subreport to the main report's DetailBand.
mainReport.Bands["DetailBand"].Controls.Add(subreport);
// Reference an XtraReport instance named "detailReport" to include its content into the main report.
subreport.ReportSource = detailReport;

VB.NET

Imports System.IO
Imports System.Drawing
Imports DevExpress.XtraReports.UI
' ...
Dim subreport As New XRSubreport() With {.BoundsF = New RectangleF(0, 100, 550, 25)}
' "mainReport" is an XtraReport instance.
' Add subreport to the main report's DetailBand.
mainReport.Bands("DetailBand").Controls.Add(subreport)
' Reference an XtraReport instance named "detailReport" to include its content into the main report.
subreport.ReportSource = detailReport

The code sample below handles the XRSubreport.BeforePrint event to add an XRLabel control to the referenced report’s instance.

C#

using DevExpress.XtraReports.UI;
// ...
private void Subreport_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    XRSubreport subreport = (XRSubreport)sender;
    XtraReport report = subreport.ReportSource;
    report.Bands["DetailBand"].Controls.Add(new XRLabel() {
        Text = " - ",
        BoundsF = new RectangleF(450, 0, 100, 25),
        Font = new Font(new FontFamily("Arial"), 9)
    });
}

VB.NET

Imports DevExpress.XtraReports.UI
' ...
Private Sub Subreport_BeforePrint(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintEventArgs)
    Dim subreport As XRSubreport = DirectCast(sender, XRSubreport)
    Dim report As XtraReport = subreport.ReportSource
    report.Bands("DetailBand").Controls.Add(New XRLabel() With {.Text = " - ", .BoundsF = New RectangleF(450, 0, 100, 25), .Font = New Font(New FontFamily("Arial"), 9)})
End Sub

Related GitHub Examples

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

C#

Reporting_how-to-create-a-hierarchical-report-t456484/CS/TreeViewReport/ChildReport.cs#L19

childReport.DataSource = parentNode.Children;
subReport.ReportSource = childReport;
childReport.ReduceControlSize(subReport, parentNode.Level);

Reporting_winforms-end-user-designer-how-to-customize-a-subreport-once-it-has-been-created-t317196/CS/WindowsFormsApplication1/OpenSubreportCommandHandler.cs#L31

XRSubreport subreport = (XRSubreport)args[0];
if (subreport.ReportSource == null && String.IsNullOrEmpty(subreport.ReportSourceUrl)) {
    subreport.ReportSource = CreateReport();

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

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

Reporting_how-to-conditionally-hide-detailreportbands-subreports-e271/CS/XtraReport2.cs#L19

// Create the detail report
SubReport reportProducts = xrSubreport1.ReportSource as SubReport;

Reporting_how-to-create-a-master-detail-report-type-using-two-report-layouts-at-runtime-e1063/CS/WindowsFormsApplication1/Form1.cs#L26

subreport.LoadLayout(Application.StartupPath + "\\SubReport.repx");
((XRSubreport)report.FindControl("xrSubreport1", true)).ReportSource = subreport;
((XRSubreport)report.FindControl("xrSubreport1", true)).BeforePrint += new System.Drawing.Printing.PrintEventHandler(Form1_BeforePrint);

VB.NET

Reporting_how-to-create-a-hierarchical-report-t456484/VB/TreeViewReport/ChildReport.vb#L21

childReport.DataSource = parentNode.Children
subReport.ReportSource = childReport
childReport.ReduceControlSize(subReport, parentNode.Level)

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

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

Reporting_how-to-conditionally-hide-detailreportbands-subreports-e271/VB/XtraReport2.vb#L17

' Create the detail report
Dim reportProducts As SubReport = TryCast(xrSubreport1.ReportSource, SubReport)

Reporting_how-to-create-a-master-detail-report-type-using-two-report-layouts-at-runtime-e1063/VB/WindowsFormsApplication1/Form1.vb#L24

subreport.LoadLayout(Application.StartupPath & "\SubReport.repx")
CType(report.FindControl("xrSubreport1", True), XRSubreport).ReportSource = subreport
AddHandler (CType(report.FindControl("xrSubreport1", True), XRSubreport)).BeforePrint, AddressOf Form1_BeforePrint

reporting-winforms-master-detail-subreport/VB/Reports/MasterReport.vb#L14

Dim xrSubReport As XRSubreport = DirectCast(sender, XRSubreport)
Dim subRep As DetailReport = TryCast(xrSubReport.ReportSource, DetailReport)
subRep.Parameters("CatID").Value = Convert.ToInt32(GetCurrentColumnValue("CategoryID"))