iPrintReport (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Print functions

Principle for printing a report
Report with lower and upper bounds
Executing a query and a report based on this query
Print destination
Passing parameters
Printing a component report
Nested reports

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

iPrintReport (Function)

In french: iImprimeEtat

Prints a report created with the report editor.

Caution: The WLanguage code required to print the report depends on the report data source. For more details and examples, see:

Printing a report based on an HFSQL data file.
Printing a report based on a query.
Printing a report based on an HFSQL view.
Printing a report based on a memory area.
This option is not available in this version.
Printing a report based on a Table control.
This option is not available in this version.
Printing a report based on a text file.
Printing a report on an SQL query on an ODBC file.
This option is not available in this version.

The reports are available in PDF format in Linux. For more details, see Printing in Linux.

With Reports & Queries, you can print a report via one of the following options:

by printing directly ().
by opening the report test window ().

Therefore, no programming is required to print the report.

In order for the reports created in Reports & Queries to be directly printed from a WINDEV application, this feature must be implemented by the provider of WINDEV application.

The provider can for example include a window allowing the end user to:

select a report created in Reports & Queries.
run this report.

Example

See additional examples

// Simple print on printer
iPrintReport(RPT_Invoice)

// Print in the report viewer (preview)
iDestination(iViewer)
iPrintReport(RPT_Invoice)

// No preview available in web
// Create and display a file
// =====================================
// Create a unique file name
MyUniqueFile is string = fDataDir() + "\" + DateSys() + TimeSys() + ".pdf"
// Destination of the report: Print the report in a PDF file
iDestination(iGenericPDF, MyUniqueFile)
// Print report based on "TABLE_CustomerTable"
iPrintReport(RPT_CustomerTable)
// Display the report in PDF format
FileDisplay(MyUniqueFile, "application/pdf")
// Delete the file
fDelete(MyUniqueFile)

Syntax

<Result> = iPrintReport(<Report> [, <Parameter 1> [... [, <Parameter N>]]])

<Result>: Type of result returned by the report (optional)

Value returned by printing the report. This value is returned:
by the RETURN keyword used in the report closing code.
by ReturnedValue used before closing the report.

<Report>: Name of the report or string

Report to be printed:
Name of the report, defined in the report editor.
Physical name of the report (including its path) if the compiled code is included in the report.
This parameter can only correspond to the report name defined in the report editor. You cannot use the physical name of the report.

<Parameter 1>: Optional parameters (the type corresponds to the parameter type)

Optional parameter expected by the report. This parameter was defined in the report opening code. This parameter can be the name of a view, the name of a memory area, etc.
Caution: If lower bounds and upper bounds have been specified for the report, the first two parameters must correspond the lower bound and to the upper bound (respectively).

<Parameter N>: Optional parameters (the type corresponds to the parameter type)

Optional parameter expected by the report. This parameter was defined in the report opening code. This parameter can be the name of a view, the name of a memory area, etc.
Caution: If lower bounds and upper bounds have been specified for the report, the first two parameters must correspond the lower bound and to the upper bound (respectively).

Remarks

Principle for printing a report

iPrintReport reads the report data source (data files, query, Table control, etc.). iPrintReport prints the Body block for each record. The other blocks are printed when necessary:

The Start of document block will be printed at the beginning of the document.
The End of document block will be printed at the end of the document.
The Page header block will be printed at the top of each page.
The Page footer block will be printed at the bottom of each page.
If there is a break, the Body block of the break will be located between the Break header block and the Break footer block.

Report with lower and upper bounds

If the lower and upper bounds were specified when the report was created in the report editor, the first two parameters passed to the report via iPrintReport must correspond to the lower bound and to the upper bound, respectively.

Example: a report was created on Customer file. This report browses the file on the "CustomerNum" key item. This report was defined as being bounded, with specified minimum and maximum bounds ("Data" tab in the report description window.

The following code is used to print the report for customers 2 to 5:

iDestination(iViewer)
iPrintReport(RPT_Customer_Prospects, "2", "5")

Executing a query and a report based on this query

When printing a report based on a query, if the query has already been executed, it is not executed again. To re-execute the query (to add records, for example), simply use HExecuteQuery or iInitReportQuery.

Print destination

You can set the print destination of the report using iDestination.

iDestination with the iViewer constant is used to display the printout in a report viewer. The user can then select the printing mode (PDF, printer, etc.). To find out whether the print job was started from the report viewer, use iDocumentPrinted.

Passing parameters

The parameters specified by iPrintReport correspond to the parameters defined in the report opening code via the following syntax:

PROCEDURE <ReportName> (<NameParam1>, <NameParam2> = "<DefaultValue>", ...
<NameParamN> = "<DefaultValue>")

Reminder: Some of the parameters passed to a procedure can be optional parameters. When declaring the procedure, the optional parameters must be described in last position (on the right), with a default value preceded by the "=" sign. For more details, see Procedure parameters.

If the report is based on a query, iInitReportQuery must be used to pass the query parameters before printing the report.

Printing a component report

To print a component report, use the name of component report (the component being included in the project). For example:

iPrintReport(ComponentReport)

If a conflict occurs with a project element, the element name must be prefixed by the component name. For example:

iPrintReport(MyComponent.Report)

To use the report name in a variable, specify the component name. For example:

sReport is string = "MyComponent.MyReport"
iPrintReport(sReport)

Nested reports

You can call iPrintReport within the same report. For more details, see the help about the Nested reports.

Business / UI classification: Neutral code

Component: wd300etat.dll