PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Managing the PDF/A format
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Defines the options for the generated PDF file. You can define:
  • the password used to open the file.
  • the options for compressing images.
  • the options for the presence of bookmarks.
  • the options for protecting the PDF file. You also have the ability to define the password used to modify these protection options.
  • the file format (Unicode, PDF/A).
This setting is taken into account when printing in a PDF file (file generated from the print preview, or by iPreview or iDestination).
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
iPhone/iPad This function is now available for the iPhone/iPad applications.
// Protect the PDF against printing
// and against selection and copy/paste
// No password for opening the PDF file
// Password for modifying the protection settings
iParameterPDF(iProtectionPrinting, iProtectionSelection, "", "Protection")
// Create the PDF file
iDestination(iPDF, "C:\Temp\MyPDF.PDF")
// Print code
iCreateFont(1, 16, iBold, iRoman)
PrintTitle()
PrintText()
// End of print and close the created PDF file
iEndPrinting()
// No protection on the generated document
// Maximum image quality
iParameterPDF("", "", iMaximumQuality)

// Create the PDF file
iDestination(iPDF, "C:\Temp\MyPDF.PDF")
// Print code
iCreateFont(1, 16, iBold, iRoman)
PrintTitle()
PrintText()
PrintImage()
// End of print and close the created PDF file
iEndPrinting()
Syntax

Protecting the PDF file by a password Hide the details

iParameterPDF(<Password> [, <Protection Password> [, <Quality and Bookmark>]])
<Password>: Character string (with quotes)
  • Password used to open the PDF file,
  • Empty string if no password must be used.
<Protection Password>: Optional character string (with quotes)
Password used to allow the modification of the protection options for the PDF file.
Caution: The PDF standard only supports the passwords in non-accented Latin character set (examples: the accented characters, the chinese characters, the russian characters are not allowed).
<Quality and Bookmark>: Optional Integer constant (or combination of constants)
Configures:
  • Compression level of colors and grayscale.
  • Management of bookmarks.
  • Versions 18 and later
    Management of Unicode format.
    New in version 18
    Management of Unicode format.
    Management of Unicode format.
Versions 18 and later
iPDFUnicode
New in version 18
iPDFUnicode
iPDFUnicode
PDF in Unicode format.
Notes:
  • The use of this constant is recommended if the characters found in the PDF file are wrongly encoded.
  • If this constant is used, the size of the generated PDF file will increase significantly.
Linux This constant is not available.
iHighQualityLow compression level used to get a high quality for the generated PDF.
Linux This constant is not available.
iLowQualityHigh compression level.
Linux This constant is not available.
iMaximumQualityMinimum compression level to get a maximum quality. This constant is recommended when creating a PDF file intended to be printed.
Linux This constant is not available.
iMinimumQualityMaximum compression level. The quality will be minimum. This constant can be used to create a PDF file intended to be viewed on the screen.
Linux This constant is not available.
iAverageQualityAverage compression level.
Linux This constant is not available.
iBookmarkNoneNo bookmark is taken into account by the PDF file.
iBookmarkPageThe bookmarks are taken into account by the PDF file. A bookmark is automatically defined for each page found in the PDF file. Each bookmark is named "Page <page number>" ("Page 1" for example).

Selecting the protection options Hide the details

iParameterPDF([<Protection Options> [, <Password> [, <Protection Password> [, <Quality and Bookmark>]]]])
<Protection Options>: Optional Integer constant (or combination of constants)
Format and requested protection:
Versions 21 and later
iPDFA
New in version 21
iPDFA
iPDFA
PDF in PDF/A-1b format. All the elements required to display or to print the PDF file are included in the generated file. Therefore, the size of the generated file is more important.
Caution: This option is taken into account for the current print only.
Note: This format involves some limitations:
  • Transparency of images not supported.
  • OpenType fonts not supported.
  • Use of integrable fonts.
See Managing the PDF/A format for more details.
iPhone/iPadUniversal Windows 10 App This constant is not available.
Versions 21 and later
iPDFUnicode
New in version 21
iPDFUnicode
iPDFUnicode
PDF in Unicode format
LinuxiPhone/iPad This constant is not available.
iProtectionNoneNo protection for the PDF file.
iProtectionCommentProtection against the addition or modification of comments.
iProtectionPrintingThe PDF file cannot be printed.
iProtectionModificationThe content of PDF file cannot be modified.
iProtectionSelectionThe content of PDF file cannot be copied or extracted from the file.
<Password>: Optional character string (with quotes)
  • Password used to open the PDF file,
  • Empty string if no password must be used.
<Protection Password>: Optional character string (with quotes)
Password used to allow the modification of the protection options for the PDF file.
If this password corresponds to an empty string (""), a password is automatically generated.
<Quality and Bookmark>: Optional Integer constant (or combination of constants)
Configures:
  • Quality of compression for the colors and grayscale.
  • Management of bookmarks.
  • Versions 18 and later
    Management of Unicode format.
    New in version 18
    Management of Unicode format.
    Management of Unicode format.
Versions 18 and later
iPDFUnicode
New in version 18
iPDFUnicode
iPDFUnicode
PDF in Unicode format.
Note: From version 21, this constant can be used in the <Protection Options> parameter.
LinuxiPhone/iPad This constant is not available.
iHighQualityHigh compression quality
Linux This constant is not available.
iLowQualityLow compression quality
Linux This constant is not available.
iMaximumQualityMaximum compression quality
Linux This constant is not available.
iMinimumQualityMinimum compression quality
Linux This constant is not available.
iAverageQualityAverage compression quality
Linux This constant is not available.
iBookmarkNoneNo bookmark is taken into account by the PDF file
iBookmarkPageThe bookmarks are taken into account by the PDF file. The bookmarks are taken into account by the PDF file. A bookmark is automatically defined for each page found in the PDF file. Each bookmark is named "Page <page number>" ("Page 1" for example).
Remarks
  • iParameterPDF is ignored in the middle of a print.
  • The setting performed by iParameterPDF is enabled:
    • until the end of application or site,
    • until the next call to iParameterPDF,
    • until the next call to iReset.
  • Versions 21 and later
    If the PDF/A-1b mode is enabled via iParameterPDF before displaying the print preview:
    • The option for exporting in PDF mode is modified: "PDF/A" is displayed instead of "PDF".
    • For all the prints performed from the preview (direct print, ...), the limitations will be identical to the ones defined for the export in PDF/A format: transparency of images, substitution of fonts, ...
    New in version 21
    If the PDF/A-1b mode is enabled via iParameterPDF before displaying the print preview:
    • The option for exporting in PDF mode is modified: "PDF/A" is displayed instead of "PDF".
    • For all the prints performed from the preview (direct print, ...), the limitations will be identical to the ones defined for the export in PDF/A format: transparency of images, substitution of fonts, ...
    If the PDF/A-1b mode is enabled via iParameterPDF before displaying the print preview:
    • The option for exporting in PDF mode is modified: "PDF/A" is displayed instead of "PDF".
    • For all the prints performed from the preview (direct print, ...), the limitations will be identical to the ones defined for the export in PDF/A format: transparency of images, substitution of fonts, ...
Versions 21 and later

Managing the PDF/A format

Limitations:
  • The transparency of images is not supported:
    • If the image contains a transparent background in its format, the image will be drawn on a white background.
    • If the "Transparent magenta" color is used, the image rendering may differ in the generated PDF.
  • The "Opentype" fonts are not supported because the "Opentype" fonts cannot be incorporated in the generated PDF.
  • All the fonts use must be incorporated in the generated PDF and they must contain all the displayed characters.
    • In Windows, if characters are missing, the substitution font used is "Arial Unicode ms".
    • In Linux, if characters are missing, an error is displayed.
Tip: How to find out whether the print in PDF/1-1b format is correct?
  • If the print is performed from a report, you have the ability to enable the GUI errors specific to this format ("Options" tab in the description window of the report, "Enable the errors specific to the PDF/A-1b export" option).
  • During a dynamic audit, the errors specific to the PDF/A-1b management are detected and displayed.
New in version 21

Managing the PDF/A format

Limitations:
  • The transparency of images is not supported:
    • If the image contains a transparent background in its format, the image will be drawn on a white background.
    • If the "Transparent magenta" color is used, the image rendering may differ in the generated PDF.
  • The "Opentype" fonts are not supported because the "Opentype" fonts cannot be incorporated in the generated PDF.
  • All the fonts use must be incorporated in the generated PDF and they must contain all the displayed characters.
    • In Windows, if characters are missing, the substitution font used is "Arial Unicode ms".
    • In Linux, if characters are missing, an error is displayed.
Tip: How to find out whether the print in PDF/1-1b format is correct?
  • If the print is performed from a report, you have the ability to enable the GUI errors specific to this format ("Options" tab in the description window of the report, "Enable the errors specific to the PDF/A-1b export" option).
  • During a dynamic audit, the errors specific to the PDF/A-1b management are detected and displayed.

Managing the PDF/A format

Limitations:
  • The transparency of images is not supported:
    • If the image contains a transparent background in its format, the image will be drawn on a white background.
    • If the "Transparent magenta" color is used, the image rendering may differ in the generated PDF.
  • The "Opentype" fonts are not supported because the "Opentype" fonts cannot be incorporated in the generated PDF.
  • All the fonts use must be incorporated in the generated PDF and they must contain all the displayed characters.
    • In Windows, if characters are missing, the substitution font used is "Arial Unicode ms".
    • In Linux, if characters are missing, an error is displayed.
Tip: How to find out whether the print in PDF/1-1b format is correct?
  • If the print is performed from a report, you have the ability to enable the GUI errors specific to this format ("Options" tab in the description window of the report, "Enable the errors specific to the PDF/A-1b export" option).
  • During a dynamic audit, the errors specific to the PDF/A-1b management are detected and displayed.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230prn.dll
Linux wd230prn.so
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment