The SubReport item enables you to display reports within reports and serves as a container, similar to the report sections, growing in size depending on its children.
The following screenshot shows a SubReport item at design time, allowing you to compose complex reports from various report sources. The data for each SubReport can be completely different, for example, you can combine a product listing, a sales summary, and a list of salespeople each in their own sub-report with each sub-report drawing its data from a different source. You can also pass parameters to the SubReport by using the Edit Parameters collection editor.
To set up the SubReport:
- Click the report item you want to change. The selected SubReport properties are listed in the Property Browser.
- In the
ReportSourceproperty, click the Edit Collection (…) button. As a result, the Load a Report From window opens.
- Click the Edit Parameters button to add a parameter. As a result, the Edit Parameters window opens.
- Click the New button to add a new parameter mapping.
- Assuming you have assigned the
ReportSourceproperty, the Parameter Name drop-down list will contain the names of parameters defined in the sub-report. Select a Parameter Name from the combo box to set the target for this parameter.
- The Parameter Value combo-box allows you to directly enter the value, and create an
<New Report Parameter>.
- When you are done, click OK.
The following image shows the end result.
The SubReport enables you to set up the report source either by using a Telerik Report Designer tool or programmatically.
When using relative path to the report in the UriReportSource of the SubReport, it gets resolved by default as follows:
- In the Standalone Report Designer, Reporting REST Services and Report Viewers with respect to the main report that calls the subreport;
- In custom applications rendering reports programmatically with the ReportProcessor class with respect to the application starting point.
To set the report source of the SubReport item by using a Telerik Report Designer:
- In the Design view, right-click a SubReport item to which you want to set a report source and click Properties.
- In the Properties of the item, click
ReportSource. As a result, a Load a Report from dialog appears. Select a
- Select the type of report source you will use to specify a report. For this example, click the Instance Report Source option and select the report that will serve as the detailed report.
- To specify the parameters for the report, click the Edit Parameters button. As a result, the Edit Parameters dialog appears. Click New.
- In the Parameter Name column, select the name of a report parameter in the detail report. In the Parameter Value, type or select the value to pass to the parameter in the detail report.
The following snippet demonstrates how to set the report source of the SubReport programmatically.
var instanceReportSource = new Telerik.Reporting.InstanceReportSource();
// Assigning the Report object to the InstanceReportSource
instanceReportSource.ReportDocument = new Telerik.Reporting.Examples.CSharp.Invoice();
// Adding the initial parameter values
instanceReportSource.Parameters.Add(new Telerik.Reporting.Parameter("OrderNumber", "SO43659"));
Dim instanceReportSource As New Telerik.Reporting.InstanceReportSource()
' Assigning the Report object to the InstanceReportSource
instanceReportSource.ReportDocument = New Invoice()
' Adding the initial parameter values
instanceReportSource.Parameters.Add(New Telerik.Reporting.Parameter("OrderNumber", "SO43659"))
Due to the format of the produced reports, the Standalone Report Designer includes only
If you are using the HTML5 Report Viewer to preview the report, the main report will be rendered in HTML and loaded on the client. The sub-report is considered as part of the main report content and its report source will be internally resolved without additional calls to the Reporting REST service.
The property was introduced with
R3 2022 SP1 (188.8.131.529).
It enables direct feeding of the inner report with data from the main report. When the property is set, its data will be used when processing the inner report instead of the data that is set up in the definition of the inner report.
A common scenario would be to feed the inner report with data coming from the data context of the
SubReport item. To do this, define a Binding to bind the
DataSource property to a data field.
For example, define a
=Fields.InvoiceRows to link the inner report DataSource to the collection with the invoice rows from the main report DataSource.
When working with the SubReport item, mind the following:
- Page sections are not related to the report itself, but are relative to the paper or screen. Therefore, page sections of nested or detail reports are ignored and only the page sections of the main report are visible.
- To render page sections that appear on each page, similar to page sections, consider using an unbound group (no grouping criteria specified) and set the
PrintOnEveryPageproperty of its sections to
True. Note that you cannot use the
PageNumberglobal objects in group sections.
- The Table of Contents (TOC) section is designed to be displayed at the top/bottom of the entire report document. For that reason, the TOC section of the subreport is ignored.
- To remove blank vertical space in the detail section of a SubReport, set the
DetailSectionto the height of the highest item.
- Sections can grow to accommodate their children but cannot shrink to hide empty spaces. To make the detail section shrink only at runtime, set the
Heightproperty of the
DetailSectionin the report constructor. Place the
Heightproperty assignment code right after the
The default styles used in the subreports may be overridden by inherited styles from their parent reports.
When Report items and sections use default styles (i.e. their styles are not set explicitly), they will inherit the Styles from their parents. This is valid for the SubReport item and the corresponding subreport specified by its ReportSource. This may lead to inconsistencies when rendering the subreport as a separate report and in a main report. Here is an example for clarity:
Let's have a report definition (referenced below as subreport) that doesn't have a Font specified. It will be rendered with Font size
10ptwhich is a default value, which is not explicitly set. If you have a TextBox in this report, with default Font, the text will be rendered with
10ptwhen you render the subreport as a separate report.
Let's consider a main report, with Font size set explicitly to
20pt. If we use the above subreport in our main report, the subreport text will inherit the Font size from the main report and the same text will appear with size
- (Demo) Invoice Report with a SubReport
- Creating Master-Detail Reports with the SubReport
- Binding the SubReport to Parent Report Data
- (API) SubReport
- (API) ReportSource
- (API) DataItem.DataSource
- Demo Page for Telerik Reporting
- Knowledge Base Section