iPrintPDF (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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?

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 23 and later

This function is now available for WINDEV applications.

New in version 23

This function is now available for WINDEV applications.

Example

IF iPrintPDF("MyFile.PDF") THEN
Info("Printed successfully")
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 get the details of the error, use ErrorInfo with the errMessage constant.

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

<Password>: Character string

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

<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.

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.

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.

<List of pages>: Character string

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.
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.
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.

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.

<Buffer name>: Buffer

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

<Password>: Character string

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.

<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.

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.

<Buffer name>: Buffer

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

<Password>: Character string

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.

<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 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.

<Buffer name>: Buffer

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

<Password>: Character string

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.

<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.

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.

<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.
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.

<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.

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.

<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.
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.

<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 the print was performed,
False otherwise.

<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.
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.

<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

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: wd270etatexe.dll