iPrintPDF (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

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

Preview of PDF print

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

iPrintPDF (Function)

In french: iImprimePDF

Prints the content:

of a PDF file.
of a buffer containing a PDF.
of a PDF Reader control.

What is the print destination?

When this function is used, a system window appears, allowing the user to select the printer to be used, the number of copies, etc.
When this function is used, a system window appears, allowing the user to select the printer to be used, etc..
Warning This function must be used in the application's main thread.
The default printer is used. The printer to use can be selected via iConfigure.
iDestination is used to preview the PDF file (see Remarks).

Example

IF iPrintPDF("MyFile.PDF") THEN
	Info("Printed successfully")
END

// Print the order form
FileName = fDataDir() + [fSep()] + StringBuild("ORF_%1.PDF", OrderNumber)
iDestination(iGenericPDF, FileName)
iPrintReport(RPT_OrderForm, OrderNumber, OrderNumber)
// Check the file existence
IF fFileExist(FileName) = False THEN
	Error("The PDF file was not generated")
	RETURN
END
// Confirmation to display the PDF
IF YesNo(Yes, "Display the generated order form (PDF format)?") = Yes THEN
	// Display the generated order form
	ShellExecute(FileName)
ELSE
	iPrintPDF(FileName)
END

// Print a buffer
MyPDFBuffer is Buffer
MyPDFBuffer = fLoadBuffer("C:\temp\Myfile.pdf")
IF iPrintPDF(MyPDFBuffer) THEN
	Info("Printed successfully")
END

Syntax

Printing a PDF file Hide the details

<Result> = iPrintPDF(<Name of PDF file> [, <Password> [, <Sizing> [, <List of pages>]]])

<Result>: Boolean

True if printed successfully,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.
Caution: Printing is asynchronous: when the function is called, the print setup window is displayed.. It is not possible to find out if the printout has been cancelled or if an error occurred during printing.

<Name of PDF file>: Character string

Name and path of PDF file to print. This parameter can correspond to a full path or a path relative to the current directory (returned by fCurrentDir). This parameter is case-sensitive.
Reminder: On iPhone or iPad, an application has the rights to write to its installation directory or one of its subdirectories

<Password>: Character string or Secret string

Password for opening the PDF file,
Empty string ("") if the file has no password.
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "Ansi or Unicode string".
To learn more about secret strings and how to use the vault, see Secret string vault.
Secret strings are not available for this parameter in Android/Android widget applications.
This parameter is not available.

<Sizing>: Integer constant

Print size:
iHomothetic Homothetic enlargement or reduction of the PDF document pages to adapt them to the output format, ignoring physical margins.
This constant corresponds to the option "Fit to paper size" available in PDF printing software.
iHomotheticNoEnlargement Homothetic reduction of the PDF document pages to adapt them to the output format, ignoring physical margins. Pages with a smaller format keep their format and are centered.
This constant corresponds to the option "Shrink to fit paper size" available in PDF printing software.
iHomotheticNoEnlargementPrintableArea Homothetic reduction of the PDF document pages to adapt them to the output format, taking into account physical margins. Pages with a smaller format keep their format and are centered.
This constant corresponds to the option "Fit to printer margins" available in PDF printing software.
Note: In previous versions, this constant was called iHomotheticNoEnlargementPrintableZone.
iRealSize Print in real size. The pages that use a format:
smaller than the output format are centered in the page.
bigger than the output format are truncated and are centered in the page.

This parameter is not available.

<List of pages>: Character string

List of pages to print. You have the ability to specify the range of pages to print separated by a comma, each range being in 'X-Y' format where X and Y are numbers of pages.
This parameter is not available.

Printing a buffer corresponding to a PDF file Hide the details

<Result> = iPrintPDF(<Buffer name> [, <Password> [, <Sizing> [, <List of pages>]]])

<Result>: Boolean

True if printed successfully,
False otherwise.
Caution: Printing is asynchronous: when the function is called, the print setup window is displayed.. It is not possible to find out if the printout has been cancelled or if an error occurred during printing.

<Buffer name>: Buffer

Name of Buffer variable corresponding to the PDF file to print.

<Password>: Character string or Secret string

Password for opening the PDF file,
Empty string ("") if the file has no password.
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "Ansi or Unicode string".
To learn more about secret strings and how to use the vault, see Secret string vault.
Secret strings are not available for this parameter in Android/Android widget applications.

<Sizing>: Integer constant

Print size:
iHomothetic Homothetic enlargement or reduction of the PDF document pages to adapt them to the output format, ignoring physical margins.
This constant corresponds to the option "Fit to paper size" available in PDF printing software.
iHomotheticNoEnlargement Homothetic reduction of the PDF document pages to adapt them to the output format, ignoring physical margins. Pages with a smaller format keep their format and are centered.
This constant corresponds to the option "Shrink to fit paper size" available in PDF printing software.
iHomotheticNoEnlargementPrintableArea Homothetic reduction of the PDF document pages to adapt them to the output format, taking into account physical margins. Pages with a smaller format keep their format and are centered.
This constant corresponds to the option "Fit to printer margins" available in PDF printing software.
Note: In previous versions, this constant was called iHomotheticNoEnlargementPrintableZone.
iRealSize Print in real size. The pages that use a format:
smaller than the output format are centered in the page.
bigger than the output format are truncated and are centered in the page.

This parameter is not available.

<List of pages>: Character string

List of pages to print. You have the ability to specify the range of pages to print separated by a comma, each range being in 'X-Y' format where X and Y are numbers of pages.

Printing the content of a PDF Reader control Hide the details

<Result> = iPrintPDF(<PDF Reader control> [, <Sizing> [, <List of pages>]])

<Result>: Boolean

True if printed successfully,
False otherwise.
Caution: Printing is asynchronous: when the function is called, the print setup window is displayed.. It is not possible to find out if the printout has been cancelled or if an error occurred during printing.

<PDF Reader control>: Character string

Name of PDF Reader control displaying the PDF file to print

<Sizing>: Integer constant

Print size:
iHomothetic Homothetic enlargement or reduction of the PDF document pages to adapt them to the output format, ignoring physical margins.
This constant corresponds to the option "Fit to paper size" available in PDF printing software.
iHomotheticNoEnlargement Homothetic reduction of the PDF document pages to adapt them to the output format, ignoring physical margins. Pages with a smaller format keep their format and are centered.
This constant corresponds to the option "Shrink to fit paper size" available in PDF printing software.
iHomotheticNoEnlargementPrintableArea Homothetic reduction of the PDF document pages to adapt them to the output format, taking into account physical margins. Pages with a smaller format keep their format and are centered.
This constant corresponds to the option "Fit to printer margins" available in PDF printing software.
Note: In previous versions, this constant was called iHomotheticNoEnlargementPrintableZone.
iRealSize Print in real size. The pages that use a format:
smaller than the output format are centered in the page.
bigger than the output format are truncated and are centered in the page.

This parameter is not available.

<List of pages>: Character string

List of pages to print. You have the ability to specify the range of pages to print separated by a comma, each range being in 'X-Y' format where X and Y are numbers of pages.

Remarks

Preview of PDF print

The PDF file to print can be displayed in the report viewer. Simply use function iDestination with constant iVisualizer before function iPrintPDF.

For example:

// Print the PDF in the report viewer
iDestination(iViewer)
iPrintPDF("c:\tmp\Convention.pdf")

Business / UI classification: Neutral code

Component: wd300etatexe.dll