Programming Interface

You can find a description of all options used in the PDF export module in this chapter. The options can be modified/read using the methods LlXSetParameter(..."PDF"...) and LlXGet­Parameter(..."PDF"...).

PDF.Title: Specifies the title of the generated PDF document.

PDF.Subject: Specifies the subject of the generated PDF document. Default: empty.

PDF.Author: Set the Author tag of the PDF file. Default: empty.

PDF.Creator: Set the Creator tag of the PDF file. Default: empty.

PDF.Keywords: Specifies the keywords of the generated PDF document. Default: empty.

PDF.Conformance: Set the PDF version to be used. If encryption is activated (see PDF.Encryption.EncryptFile) the encryption strength will be automatically selected. Various options are available, which are explained below.

Value

Meaning

pdf14

PDF version 1.4 (corresponds to Acrobat 5)

pdf15

PDF version 1.5

pdf16

PDF version 1.6 (corresponds to Acrobat 7)

pdf17

PDF version 1.7 (ISO 32000-1)

pdf20

PDF version 2.0 (ISO 32000-2)

pdfa1b

PDF/A-1b (ISO 19005-1, Level B compliance)

pdfa1a

PDF/A-1a (ISO 19005-1, Level A compliance)

pdfa2b

PDF/A-2b (ISO 19005-2, Level B compliance)

pdfa2u

PDF/A-2u (ISO 19005-2, Level U compliance)

pdfa2a

PDF/A-2a (ISO 19005-2, Level A compliance)

pdfa3b

PDF/A-3b (ISO 19005-3, Level B compliance)

pdfa3u

PDF/A-3u (ISO 19005-3, Level U compliance)

pdfa3a

PDF/A-3a (ISO 19005-3, Level A compliance)

Default

pdf17

 

PDF.Encryption.EncryptFile: If this parameter is set, the result file is encrypted. The encryption type is automatically determined by the selected PDF version (see PDF.Conformance). There are several other options available, which are explained below.

Value

Meaning

0

Do not encrypt file

1

Encrypt file

Encryption type based on the selected PDF version:

pdf10, pdfa[x]: no encryption

pdf11, pdf12, pdf13: RC4 with a key length of 40

pdf14: RC4 with a key length of 128

pdf15, pdf16, pdf17: AES with a key length of 128

pdf20: AES with a key length of 256

Default

0

 

PDF.Encryption.EnablePrinting: If this parameter is set, the file can be printed even if it is encrypted. Only effective if PDF.Encryption.EncryptFile is set to "1".

Value

Meaning

0

Printing is not enabled

1

Printing is enabled

Default

0

 

PDF.Encryption.EnableChanging: If this parameter is set, the file can be changed even if it is encrypted. Only effective if PDF.Encryption.EncryptFile is set to "1".

Value

Meaning

0

Changing is not enabled

1

Changing is enabled

Default

0

 

PDF.Encryption.EnableCopying: If this parameter is set, the file can be copied to the clipboard even if it is encrypted. Only effective if PDF.Encryption.EncryptFile is set to "1".

Value

Meaning

0

Copying is not enabled

1

Copying is enabled

Default

0

 

PDF.Encryption.EnableFillingForms: If this parameter is set, any form fields and also signature fields can be filled in and used in the PDF file despite encryption. Only effective if PDF.Encryption.EncryptFile is set to "1".

Value

Meaning

0

Filling and signing are not enabled

1

Filling and signing are enabled

Default

0

 

PDF.Encryption.EnableAnnotating: If this parameter is set, annotations can be made in the PDF file despite encryption. Only effective if PDF.Encryption.EncryptFile is set to "1".

Value

Meaning

0

Annotating is not enabled

1

Annotating is enabled

Default

0

 

Note: Once the option is allowed, form and signature field filling is also automatically allowed according to the PDF security attributes, see PDF.Encryption.EnableFillingForms.

PDF.FileAttachments: With this parameter, additional files can be added to the PDF container. Pass them as follows:

<MyAdditionalFile1>|<MyAdditionalFileDescription1>;<MyAdditionalFile2>|<MyAdditionalFileDescription2>

PDF.OwnerPassword: The owner password for the encrypted file. This password is needed to edit the file. If no password is given, a random password will be assigned. We recommend that you always explicitly choose a suitable password.

PDF.UserPassword: The user password for the encrypted file. This password is needed to access the encrypted file. If no password is given, access is possible without a password, but may be limited (see above).

PDF.UseSimpleFrames: Specifies that the simple default border lines for tables and objects such as dotted, dashed, dashed-dotted and dashed-dotted-dotted should be drawn more effectively by Windows (different rendering possible). This can lead to higher overall performance and smaller export files when creating reports.

Value

Meaning

0

Simplified drawing of the frame lines deactivated.

1

Simplified drawing of the frame lines activated.

Default

0

 

PDF.ExcludedFonts: Determines which fonts should not be embedded. Some fonts (e.g. Arial, Courier) can be identically replaced by PostScript fonts. This option can be used to explicitly exclude individual fonts from embedding – e.g. "Arial;Courier;...". Default: "Arial".

Note: If "*" is specified, no fonts are embedded, only the name of the fonts contained. This activates the Windows font mapping of the used PDF viewer, which then uses the most suitable font in the system for displaying. Thus, the file size can usually be kept very small.

PDF.ZUGFeRDConformanceLevel: Set the ZUGFeRD Conformance Level.

Value

Meaning

BASIC

Simple invoices with structured data. Additional information possible as free text.

EXTENDED

Intersectoral invoice exchange with extended structured data.

COMFORT

Fully automated invoice processing with structured data. Only relevant for ZUGFeRD 1.0. For ZUGFeRD 2.0/2.1 please use "EN 16931".

EN 16931

Fully automated invoice processing with structured data. Only valid for ZUGFeRD 2.0/2.1. Identical with XRechnung 1.0.

BASIC WL

The profile is also included in ZUGFeRD 2.0/2.1 for reasons of consistency between the two standards ZUGFeRD and Factur-X, but in Germany it does not constitute a full invoice within the meaning of the German UStG (VAT Act).

MINIMUM

The profile is also included in ZUGFeRD 2.0/2.1 for reasons of consistency between the two standards ZUGFeRD and Factur-X, but in Germany it does not constitute a full invoice within the meaning of the German UStG (VAT Act).

XRECHNUNG

The profile meets the specific requirements of public administration in Germany. It meets the requirements of the European standard EN16931 and also the national business rules and administrative provisions of the XRechnung standard. Requires ZUGFeRD 2.1.

Default

BASIC

 

PDF.ZUGFeRDVersion: Set the ZUGFeRD version.

Value

Meaning

0

In the specified XML file (see PDF.ZUGFeRDXmlPath), an attempt is made to automatically determine which ZUGFeRD version and which ZUGFeRD conformance level (see ZUGFeRDConformanceLevel) are involved and this is then applied. If the information cannot be determined automatically, the ZUGFeRD version is set to "2.0" and the ZUGFeRD conformance level to "BASIC".

1.0

ZUGFeRD version 1.0 is forced (filename: ZUGFeRD-invoice.xml).

2.0

ZUGFeRD version 2.0 is forced (filename: ZUGFeRD-invoice.xml).

2.1

Factur-x is forced which corresponds to ZUGFeRD version 2.1 (filename: factur-x.xml) and is also required by profile XRECHNUNG.

Default

0

 

PDF.ZUGFeRDXmlPath: Defines the path to a ZUGFeRD compliant XML file, which should be embedded in the final PDF. The file name must correspond to the ZUGFeRD version set (see PDF.ZUGFeRD version). The XML file must be created before by the application itself.

Picture.JPEGQuality: Specifies the quality and the corresponding compression factor of the generated JPEG graphic. The value lies between 0 and 100, with 100 representing the highest quality (and therefore the least compression). Takes effect only when the source graphic is not the JPEG format, as encoding of JPEG to JPEG would result in a quality loss. Default: 75

Export.Path: Path where the exported files should be saved. If this option is empty, a file selection dialog will always be displayed.

Export.File: File name of the document.

Export.Quiet: Use this option to configure the possibility of exporting without user interaction.

Value

Meaning

0

Export with user interaction (dialogs)

1

No dialogs or message boxes – even overwrite warnings - will be displayed (only if Export.Path was specified).

Default

0

 

Export.ShowResult: Specifies whether the export result will be displayed automatically. The program that displays the result will be determined by the registered file extension.

Value

Meaning

0

Result will not be displayed automatically

1

Calls ShellExecute() with Export.File.

Default

0

 

Export.ShowResultAvailable: Enables you to hide the respective checkbox in the dialog.

Value

Meaning

0

Checkbox will be hidden

1

Checkbox will be available

Default

1