iPrintPDF (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Operating mode on the phone

Required permissions

Preview of PDF print

See also

iPrintPDF (Function)

In french: iImprimePDF

Prints the content:

of a PDF file.
Versions 23 and later
of a buffer containing a PDF.
New in version 23
of a buffer containing a PDF.
of a buffer containing a PDF. of a buffer containing a PDF.
Versions 23 and later
of a PDF Reader control.
New in version 23
of a PDF Reader control.
of a PDF Reader control. of a PDF Reader control.

What is the print destination?

When this function is called, a system window is displayed, allowing the user to select the printer to use, the number of copies, ...
When this function is called, a system window appears to allow the user to select the printer to use, ...
Caution: This function must be used in the main thread of the application.
Versions 23 and later
The printer to use can be selected via iDestination.
iDestination is used to preview the PDF file (see Remarks).
New in version 23
The printer to use can be selected via iDestination.
iDestination is used to preview the PDF file (see Remarks).
The printer to use can be selected via iDestination.
iDestination is used to preview the PDF file (see Remarks).

Versions 19 and later

This function is now available in Android Widget mode.

This function is now available for Android applications.

New in version 19

This function is now available in Android Widget mode.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available for Android applications.

Versions 23 and later

This function is now available for WINDEV applications.

This function is now available for WEBDEV sites.

New in version 23

This function is now available for WINDEV applications.

This function is now available for WEBDEV sites.

This function is now available for WINDEV applications.

This function is now available for WEBDEV sites.

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

Versions 23 and later

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

New in version 23

// 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 the print was performed,
False otherwise. To find out the name of the error, use the function ErrorInfo with the constant errMessage.
Caution: Printing is asynchronous: When the function is called, the print settings window appears. 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 (with quotes)

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/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.

<Password>: Character string (with quotes)

Versions 23 and later
Password for opening the PDF file,
Empty string ("") if the file has no password.
This parameter is not available.
New in version 23
Password for opening the PDF file,
Empty string ("") if the file has no password.
This parameter is not available.
Password for opening the PDF file,
Empty string ("") if the file has no password.
This parameter is not available.

<Sizing>: Integer constant

Versions 23 and later
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.
Versions 25 and later
iHomotheticNoEnlargementPrintableZone
New in version 25
iHomotheticNoEnlargementPrintableZone
iHomotheticNoEnlargementPrintableZone 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.
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.
New in version 23
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.
Versions 25 and later
iHomotheticNoEnlargementPrintableZone
New in version 25
iHomotheticNoEnlargementPrintableZone
iHomotheticNoEnlargementPrintableZone 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.
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.
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.
Versions 25 and later
iHomotheticNoEnlargementPrintableZone
New in version 25
iHomotheticNoEnlargementPrintableZone
iHomotheticNoEnlargementPrintableZone 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.
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 (with quotes)

Versions 23 and later
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.
New in version 23
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.
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.

This syntax is available in Android from version 250064.

Versions 23 and later

Printing a buffer corresponding to a PDF file Hide the details

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

<Result>: Boolean

True if the print was performed,
False otherwise.
Caution: Printing is asynchronous: When the function is called, the print settings window appears. 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 (with quotes)

Password for opening the PDF file,
Empty string ("") if the file has no password.

<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.
Versions 25 and later
iHomotheticNoEnlargementPrintableZone
New in version 25
iHomotheticNoEnlargementPrintableZone
iHomotheticNoEnlargementPrintableZone 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.
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 (with quotes)

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.

New in version 23

Printing a buffer corresponding to a PDF file Hide the details

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

<Result>: Boolean

True if the print was performed,
False otherwise.
Caution: Printing is asynchronous: When the function is called, the print settings window appears. 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 (with quotes)

Password for opening the PDF file,
Empty string ("") if the file has no password.

<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.
Versions 25 and later
iHomotheticNoEnlargementPrintableZone
New in version 25
iHomotheticNoEnlargementPrintableZone
iHomotheticNoEnlargementPrintableZone 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.
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 (with quotes)

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 a buffer corresponding to a PDF file Hide the details

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

<Result>: Boolean

True if the print was performed,
False otherwise.
Caution: Printing is asynchronous: When the function is called, the print settings window appears. 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 (with quotes)

Password for opening the PDF file,
Empty string ("") if the file has no password.

<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.
Versions 25 and later
iHomotheticNoEnlargementPrintableZone
New in version 25
iHomotheticNoEnlargementPrintableZone
iHomotheticNoEnlargementPrintableZone 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.
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 (with quotes)

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 syntax is available in Android from version 250064.

Versions 23 and later

Printing the content of a PDF Reader control Hide the details

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

<Result>: Boolean

True if the print was performed,
False otherwise.
Caution: Printing is asynchronous: When the function is called, the print settings window appears. 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 (with or without quotes)

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.
Versions 25 and later
iHomotheticNoEnlargementPrintableZone
New in version 25
iHomotheticNoEnlargementPrintableZone
iHomotheticNoEnlargementPrintableZone 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.
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 (with quotes)

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.

New in version 23

Printing the content of a PDF Reader control Hide the details

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

<Result>: Boolean

True if the print was performed,
False otherwise.
Caution: Printing is asynchronous: When the function is called, the print settings window appears. 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 (with or without quotes)

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.
Versions 25 and later
iHomotheticNoEnlargementPrintableZone
New in version 25
iHomotheticNoEnlargementPrintableZone
iHomotheticNoEnlargementPrintableZone 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.
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 (with quotes)

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 the print was performed,
False otherwise.
Caution: Printing is asynchronous: When the function is called, the print settings window appears. 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 (with or without quotes)

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.
Versions 25 and later
iHomotheticNoEnlargementPrintableZone
New in version 25
iHomotheticNoEnlargementPrintableZone
iHomotheticNoEnlargementPrintableZone 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.
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 (with quotes)

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

Google Cloud Print

Google Cloud Print is a free service used to send, on Google servers, the files that will be printed on the preset printers. Therefore, the print is performed via Internet.

To use the Google Cloud Print service:

Configure the printers on the site of Google Cloud Print.
In the application, use iPrintPDF.

See the site for more details about the use conditions of Google Cloud Print service : http://www.google.com/cloudprint.

Operating mode on the phone

iPrintPDF opens several pages in the current application.

If the user is not connected, a page for connecting to Google is displayed. In this page, you must type the login and password of the Google account that was used to define the printers.
A page proposes the different available printers. All you have to do is select the requested printer to define the print options and to start the final print.

Required permissions

The call to this function modifies the permissions required by the application.

Required permission: INTERNET: this permission allows the applications to open the network sockets.

Versions 23 and later

Preview of PDF print

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

For example:

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

New in version 23

Preview of PDF print

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

For example:

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

Preview of PDF print

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

For example:

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

Business / UI classification : Neutral code

Component : wd260etatexe.dll