<pdfDocument variable>.Save (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / PDF functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<pdfDocument variable>.Save (Function)

In french: <Variable pdfDocument>.Sauve

Saves the content of a pdfDocument variable in a".PDF" file.

Example

MyPDF is pdfDocument = "Test.pdf"
FOR EACH DocumentPage OF MyPDF.Page
	Trace(DocumentPage.Height)
END
MyPDF.Save("passwordtest.pdf")

Syntax

<Result> = <PDF to save>.Save(<Name and path of the PDF file> [, <Quality>] [, <Password>])

<Result>: Boolean

True if saved successfully,
False otherwise. To get more details on the error, use ErrorInfo.

<PDF to save>: pdfDocument variable

Name of the pdfDocument variable that corresponds to the PDF document to save.

<Name and path of the PDF file>: Character string

Name and full (or relative) path of PDF file to create.

<Quality>: Optional Integer constant

Configures the compression level of colors and grayscale.
iAverageQuality Average compression level.
This constant is not available.
iHighQuality Low compression level used to get a high quality for the generated PDF.
This constant is not available.
iLowQuality High compression level.
This constant is not available.
iMaximumQuality Minimum compression level to get a maximum quality. This constant is recommended when creating a PDF file intended to be printed.
This constant is not available.
iMinimumQuality Maximum compression level. The quality will be minimum. This constant can be used to create a PDF file intended to be viewed on the screen.
This constant is not available.
iQualityAutomatic Compression level automatically calculated to generate a better-quality PDF file (especially for images).
This constant is not available.

<Password>: Optional string or Secret string

New password to open the PDF file.
If this parameter is an empty string (""), the PDF will have no password.
If this parameter is not specified, the PDF document will keep its password if it has one.
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.
New in version 2025
Secret strings are not available for this parameter in Android/Android widget applications.
This parameter is not available.

Remarks

Starting with version 28, this function is not supported by 32-bit ARM processors. New PDF features require a 64-bit execution mode.
If an application is to be run on devices with 32-bit ARM processors, it must be generated with WINDEV Mobile 27.

Business / UI classification: Business Logic

Component: wd300wdpdf.dll