- Managing the PDF/A format
iParameterPDF (Function) In french: iParamètrePDF 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 New in version 21
// 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, iProtectionSélection, "", "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 laterManagement of Unicode format. New in version 18Management of Unicode format. Management of Unicode format.
| | Versions 18 and lateriPDFUnicode New in version 18iPDFUnicode iPDFUnicode | PDF in Unicode format.
Remarks:- 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.
| | iHighQuality | Low compression level used to get a high quality for the generated PDF. | | iLowQuality | High compression level. | | iMaximumQuality | Minimum compression level to get a maximum quality. This constant is recommended when creating a PDF file intended to be printed. | | 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. | | iAverageQuality | Average compression level. | | iBookmarkNone | No bookmark is taken into account by the PDF file. | | iBookmarkPage | 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). |
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: | | iPDFA
ou
Versions 24 and lateriPDFA1b New in version 24iPDFA1b iPDFA1b | 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 generated file is bigger. Caution: This option is taken into account for the current print only. Remark: This format involves some limitations: - Transparency of images not supported.
- OpenType fonts not supported.
- Use of integrable fonts.
| Versions 24 and lateriPDFA3b New in version 24iPDFA3b iPDFA3b | PDF in PDF/A-3b format: - All the elements required to display or to print the PDF file are included in the generated file. Therefore, the generated file is bigger.
- It is possible to add XML, CSV, word processing, spreadsheet files, ... in PDF format. This can be done via iAddAttachment.
Caution: This option is taken into account for the current print only. Remark: This format involves some limitations: - Transparency of images not supported.
- OpenType fonts not supported.
- Use of integrable fonts.
| Versions 21 and lateriPDFUnicode New in version 21iPDFUnicode iPDFUnicode | PDF in Unicode format | | iProtectionNone | No protection for the PDF file. | | iProtectionComment | Protection against the addition or modification of comments. | | iProtectionPrinting | The PDF file cannot be printed. | | iProtectionModification | The content of PDF file cannot be modified. | | iProtectionSelection | The 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 laterManagement of Unicode format. New in version 18Management of Unicode format. Management of Unicode format.
| | Versions 18 and lateriPDFUnicode New in version 18iPDFUnicode iPDFUnicode | PDF in Unicode format. Remark: From version 21, this constant can be used in the <Protection Options> parameter. | | iHighQuality | High compression quality | | iLowQuality | Low compression quality | | iMaximumQuality | Maximum compression quality | | iMinimumQuality | Minimum compression quality | | iAverageQuality | Average compression quality | | iBookmarkNone | No bookmark is taken into account by the PDF file | | iBookmarkPage | The 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 parameter setting made with the iParameterPDF function is Active:
- until the end of application or site,
- or until the next use of the iParameterPDFfunction,
- until the next call to iReset.
Versions 21 and laterIf the PDF/A-1b mode is activated via the iParameterPDF function 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 21If the PDF/A-1b mode is activated via the iParameterPDF function 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 activated via the iParameterPDF function 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 laterManaging 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 fonts use must be incorporated in the generated PDF and they must contain all 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 21Managing 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 fonts use must be incorporated in the generated PDF and they must contain all 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 fonts use must be incorporated in the generated PDF and they must contain all 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.
Business / UI classification: Neutral code
This page is also available for…
|
|
|