pdfParameter (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

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

Properties specific to pdfParameter variables
WLanguage functions that use pdfParameter variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

pdfParameter (Variable type)

In french: pdfParamètre

The pdfParameter type defines all the characteristics of the PDF file to be generated. You can define and change the characteristics of this PDF file using different WLanguage properties.

Note: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

// Display two full pages with scrolling and cover page
Params is pdfParameter
Params.Quality = iHighQuality
Params.Zoom = zoomFullWidth
Params.PageDisplayMode = dispTwoPage + dispEnableScrolling + dispWithCoverPage
iParameterPDF(Params)
iDestination(iGenericPDF)
iPrintReport(MyReport)

ShellExecute(iLastFile())

// Display a page with scrolling and set zoom to content
param is pdfParameter
param.Zoom = zoomFitVisible
param.PageDisplayMode = dispSinglePage + dispEnableScrolling
iParameterPDF(param)
iDestination(iGenericPDF, gsPDFName)
iPrintReport(RPT_Database)

ShellExecute(gsPDFName)

// Set page zoom to 100% and enable scrolling
param is pdfParameter
param.Zoom = 100
param.PageDisplayMode = dispEnableScrolling
iParameterPDF(param)
iDestination(iGenericPDF, gsPDFName)
iPrintReport(RPT_Database)

ShellExecute(gsPDFName)

Properties

Properties specific to pdfParameter variables

The following properties can be used to manage the settings of a PDF file:

Property name	Type used	Effect

Bookmark	Boolean	True if bookmarks are to be included in the PDF file. A bookmark is automatically defined for each page in the PDF file. Each bookmark has a name in the following format "Page <page number>" (e.g. "Page 1"). False otherwise.
ColorFormat	Integer constant	Color management in the PDF file: pdfColor: Create a color PDF file. pdfGrayscale: Create a black and white PDF file.
ModificationPassword	Character string or Secret string	Password used to allow a user to change properties of the PDF file. 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.
OpeningPassword	Character string or Secret string	Password required to open the PDF file. 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.
PageDisplayMode	Integer constant	Page display mode in the PDF reader. Corresponds to a combination of the following constants: dispWithCoverPage: Sets the first page of the PDF file as cover page. The first page is displayed on the right when the page display is in 2-page mode. dispEnableScrolling: Progressive scrolling. Displays pages in an uninterrupted vertical column occupying the width of one page. Scrolling can be enabled for both 1-page and 2-page display modes. dispDefault (default): Default display. dispTwoPage: Displays two pages side by side in the PDF reader. dispSinglePage: Displays one page of the PDF file at a time in the PDF reader. Margins are not displayed.
Protection	Integer constants	Protection options for the generated PDF file. Corresponds to the combination of the following constants: Format options: iPDFA or iPDFA1b: PDF/A-1b file. All the elements required to display or print the PDF file are included in the generated file. Therefore, the generated file is bigger. Note: This format has certain limitations: Transparency of images not supported. OpenType fonts not supported. Use of embedded fonts. iPDFA3b: PDF/A-3b file. All the elements required to display or print the PDF file are included in the generated file. Therefore, the generated file is bigger. You can add different types of files to the PDF file, such as XML, CSV, word processing, spreadsheet, etc. Note: This format has certain limitations: Transparency of images not supported. OpenType fonts not supported. Use of embedded fonts. Protection options: New in SaaS iProtectionAssemble: Restricts PDF file assembly. Note: This feature is only available from WINDEV Suite SaaS 2025 - Update 3. For more details, see Using new features exclusive to WINDEV Suite SaaS 2025. iProtectionNone: No PDF file protection. New in SaaS iProtectionCopyAccessibility: Restricts copying content for accessibility purposes. Note: This feature is only available from WINDEV Suite SaaS 2025 - Update 3. For more details, see Using new features exclusive to WINDEV Suite SaaS 2025. iProtectionComment: Restricts adding or editing comments. iProtectionPrinting: The PDF file cannot be printed. iProtectionModification: The content of the PDF file cannot be modified. New in SaaS iProtectionFillForm: Form fields in the PDF file will not support user input. Note: This feature is only available from WINDEV Suite SaaS 2025 - Update 3. For more details, see Using new features exclusive to WINDEV Suite SaaS 2025. iProtectionSelection: The contents of the PDF file cannot be copied or extracted from the file.
Quality	Integer constant	Color and grayscale compression quality: iAutomaticQuality: Quality calculated automatically. iHighQuality: High compression quality. iLowQuality: Low compression quality. iMaximumQuality: Maximum compression quality. iMinimumQuality: Minimum compression quality. iAverageQuality: Average compression quality.
Unicode	Boolean	True if the PDF is to be generated in Unicode format (if it contains Unicode characters), False otherwise. Note: If the PDF file is to be generated in Unicode format, the resulting PDF file will be larger.
Version	Integer constant	Version of the generated PDF: iPDF14: File generated using PDF 1.4 (default). iPDF15: File generated using PDF 1.5 iPDF16: File generated using PDF 1.6 iPDF17: File generated using PDF 1.7
Zoom	Integer or Integer constant	Default zoom when the PDF file is opened: Zoom value between 25% and 6400%, zoomFitVisible: Zoom to display the page so that the text and images occupy the entire width of the view. zoomDefault: Default zoom. zoomFullPage: Zoom to display the whole page. zoomFullHeight: Zoom to full page height. zoomFullWidth: Zoom to full page width. zoomActualSize: 100% zoom.

Remarks

WLanguage functions that use pdfParameter variables


iParameterPDF	Defines the options for the generated PDF file.
PDFAddImage	Adds an image to a page in an existing PDF file.
PDFAddWatermark	Adds a watermark to all or some pages of an existing PDF file.