<Report>.Print (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Principle for printing a report

Report with lower and upper bounds

Running a query and report based on this query

Print destination

Passing parameters

Printing a component report

RPC and independent HFSQL context

Nested reports

See also

<Report>.Print (Function)

In french: <Etat>.Imprime

Prints a report created with the report editor.

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

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

Versions 15 and later

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

New in version 15

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

Versions 18 and later

This function is now available for iPhone/iPad applications.

New in version 18

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Important

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.

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Example

// Simple print on printer
RPT_Invoice.Print()

// Print in the report viewer
iDestination(iViewer)
RPT_Invoice.Print()

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

Syntax

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

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

Versions 20 and later
Value returned by printing the report. This value is returned:
or by the keyword RESULT present in the report lock code.
by ..ReturnedValue used before closing the report.
New in version 20
Value returned by printing the report. This value is returned:
or by the keyword RESULT present in the report lock code.
by ..ReturnedValue used before closing the report.
Value returned by printing the report. This value is returned:
or by the keyword RESULT present in the report lock code.
by ..ReturnedValue used before closing the report.

<Report>: Report name

Name of report, defined in the report editor.

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

Optional parameter expected by the report. This parameter was defined in the opening code of report. This parameter can be the name of a view, the name of a memory zone, 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 opening code of report. This parameter can be the name of a view, the name of a memory zone, 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

<Report>.Print reads the report data source (data files, query, Table control, etc.). <Report>.Print 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 document.
The End of document block will be printed at the end of 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 <Report>.Print 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)
RPT_Customers_Prospects.Print("2", "5")

Running a query and report based on this query

When printing a report based on a query, the query is not re-run if it was already run. To force the re-execution of the query (e.g., add records), simply use 0 or <Report>.InitRequest.

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 was started from the report viewer, use iDocumentPrinted.

Passing parameters

The parameters specified by <Report>.Print correspond to the parameters defined in the opening code of report 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 Parameter of a procedure.

If the report is based on a query, <Report>.InitRequest 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:

ComponentReport.Print()

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

MyComponent.Report.Print()

To use the name of the report in a variable, the name of the component must be specified. For example:

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

RPC and independent HFSQL context

The access to an HFSQL data file in RPC is not allowed from a report with an independent context.

The "Independent HyperFileSQL context" option must be disabled.

To disable this option in a report, uncheck "The report execution does not affect the browse operations (independent HyperFileSQL context)" in the "Data" tab of the report description.

The "Independent HFSQL context" option must be disabled.

To disable this option in a report, uncheck "The report execution does not affect the browse operations (independent HFSQL context)" in the "Data" tab of the report description window.

In an application that uses the remote access, if independent contexts must be used, they must be programmed by <Source>.SavePosition and <Source>.ReturnPosition.

Remark: The contexts cannot be copied in RPC. You must use HOpenAnalysis or HConnectRemoteAccess in the new context to access the RPC.

Nested reports

You have the ability to call <Report>.Print within the same report. See the help about the Nested reports for more details.

Business / UI classification: Neutral code

Component: wd260etat.dll