Creating nested reports

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Creating a nested report

Example 1: Simple nested reports

Example 2: Nested reports with different orientations (Landscape/Portrait)

Specific features of secondary reports

See also

Creating nested reports

Creating a nested report

Principle

The creation of a main report containing several secondary reports is performed in several steps:

Creating a main report.
Creating the secondary reports. The orientation of these reports can differ from the orientation of main report.
Printing secondary reports in the main report with iPrintReport. This function must be used:
- in the event "Before printing" of a block: the secondary report will be printed before this block.
- in the event "After printing" of a block: the secondary report will be printed after this block.
  Caution: If the nested reports have different orientations, it is necessary to call function iParameter to change the print orientation accordingly.
Configuring the print of page headers and footers for the nested report (iNestedHeaderFooter). This function can be used:
- in the opening code of main report: it will be taken into account by all the nested reports that will be printed from the main report.
- before printing the nested report: it will be taken into account by the following nested report.
Printing the main report. See Printing a main report that includes several secondary reports for more details.

Versions 17 and later
Remark: To print reports with different orientations (portrait/landscape), we recommend that you use the sequencing of reports. This method can be easily implemented. For more details, see Sequencing reports.

New in version 17
Remark: To print reports with different orientations (portrait/landscape), we recommend that you use the sequencing of reports. This method can be easily implemented. For more details, see Sequencing reports.

Remark: To print reports with different orientations (portrait/landscape), we recommend that you use the sequencing of reports. This method can be easily implemented. For more details, see Sequencing reports.

Example 1: Simple nested reports

Example to perform

The "RPT_Orders" report is based on the "Orders" data file. This report is used to print the characteristics of each order (date, customer number, total amount, ...). A break on the "OrderNum" item is used to separate the different orders.

The "QRY_ProductOrdered" query selects all the products of a specified order. This query expects an order number as parameter.

The "RPT_ProductOrdered" report is based on the "QRY_ProductOrdered" query. This report only prints the products selected by the "QRY_ProductOrdered" query.

The "RPT_ProductOrdered" report corresponds to the secondary report. This report will be printed after each break.

Operations to perform

Create the "RPT_Orders" report: this report corresponds to the main report.
- Click among the quick access buttons.
- The element creation window appears: click "Report" then "Report".
Create the "QRY_ProductOrdered" query. See Creating a query with parameters for more details.
Create the "RPT_ProductOrdered" report: this report corresponds to the secondary report.
- Click among the quick access buttons.
- The element creation window appears: click "Report" then "Report".
  Remark: The Page footer block of this report will not be printed. See Blocks in the secondary report for more details.
Write the following code In the event "After printing" of the block End of break of "RPT_Order":

// Initialize the query and
// pass in parameter the number of the order currently printed
iInitReportQuery(RPT_ProductOrdered, MySource.OrderNum)
// Print the nested report
iPrintReport(RPT_ProductOrdered)

Example 2: Nested reports with different orientations (Landscape/Portrait)

Example to perform

The main report ("RPT_LANDSCAPE") is printed in landscape mode. A sub-report ("RPT_PORTRAIT") in portrait mode must be called for each printed element. The secondary report must be started (by changing the orientation) in the "Post-print" code of the body block of the main report. Then, the secondary report must restore the orientation of the main report at the end of print.

Operations to perform

Create the "RPT_LANDSCAPE" report: this report corresponds to the main report.
- Click among the quick access buttons.
- The element creation window appears: click "Report" then "Report".
- Choose an orientation in landscape mode.
  Remark: This report can be any type of report that is using data coming from any source: file, query, table, programming, ...
In the description of the main report, in the "Options" tab, check "Print the report as is".
In the "Format" tab, specify the margins and the indent. Validate the description window of the report.
Create the "RPT_PORTRAIT" report: this report corresponds to the secondary report.
- Click among the quick access buttons.
- The element creation window appears: click "Report" then "Report".
- Choose an orientation in portrait mode.
  Remark: This report can be any type of report that is using data coming from any source: file, query, table, programming, ...
In the description of the secondary report, in the "Options" tab, check "Print the report as it is".
In the "Format" tab, specify the same margins and the same indent as the ones specified for the main report. Validate the description window of the report.
Write the following code in the event "After printing" of the block PAGE FOOTER of "RPT_LANDSCAPE" (main report):

// Call to the report with a different orientation (portrait mode here)
iPrintReport(RPT_PORTRAIT)
// Note: If this secondary report includes a page footer, this page footer will not be printed.

Specific features of secondary reports

Blocks in the secondary report

By default, when printing a secondary report (with iPrintReport), all the blocks in the secondary report are printed except for the following blocks:

the Page header block.
the Page footer block.

To force these blocks to be printed, use iNestedHeaderFooter.

Remark: If the secondary report contains a table whose header is found in the Page header block, only the Page footer block will not be printed (all the other blocks will be printed). In this case, the Page header block will be printed before the first row of the table (found in the secondary report).

Orientation of secondary report

The secondary report and the main report can have different orientations. In this case, iParameter must be called to modify the print orientation accordingly.

Remark: To print reports with different orientations (portrait/landscape), we recommend that you use the sequencing of reports. This method can be easily implemented. See Sequencing reports for more details.

Page break in the secondary report

The page breaks defined in a secondary report will be taken into account when printing the main report.

Secondary report based on a query with parameters

If the secondary report is based on a query with parameters, use iInitReportQuery to pass the parameters to the query. This function must be used before iPrintReport.

Secondary report based on a query that uses a specific connection

If the secondary report is based on a query that handles a specific connection, use iInitReportQueryConnection to run this query (and to pass parameters if necessary). This function must be used before iPrintReport.

Secondary report printed from a Page Footer block

If the secondary report is printed from a Page Footer block, its Page Footer blocks will not be printed.

Displaying the total number of pages in the secondary report

A page counter must be added into the main report in order for the pages counter to operate in the nested report. However, the counter found in the main report can be made invisible if necessary.