PDFReaderOpen (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

PDFReaderOpen (Function)

In french: LecteurPDFOuvre

Opens a PDF file displayed in a PDF Reader control.

Versions 25 and later

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

New in version 25

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

Example

PDFReaderOpen(PDF_MyPDFReader, "C:\MyDocument.pdf")

Syntax

<Result> = PDFReaderOpen(<PDF Reader control> , <Path> [, <Password>])

<Result>: Boolean

True if the PDF file was successfully opened,
False otherwise. The document currently displayed in the control is not modified. To get the details of the error, use ErrorInfo with the errMessage constant.

<PDF Reader control>: Control name

Name of PDF Reader control to use.

<Path>: Character string (with quotes)

Full or relative path of PDF file to open.

<Password>: Optional character string (with quotes)

Password required to open the file (PDF file protected in opening).
If this parameter is not specified and if the PDF file is password protected, a window will be displayed, allowing the user to type the password.
If this parameter is not specified and if the PDF file is password-protected, the function will return an error.
The function will return an error if the specified password is not valid for the document.

Remarks

To close the PDF document displayed in the PDF Reader control, use PDFReaderClose.

Business / UI classification: UI Code

Component: wd260obj.dll