CIB pdf toolbox technical guide (EN)

CIB pdf toolbox

CibPdf32(64).dll

CibPdf32(64).lib

CibPdf32(64).h

CibDataCsv(64).dll

CibDataXml(64).dll

CIBxalan(64).dll

Xalan-C_1_5_0.dll

xerces-c_2_2_0.dll

cibjbig232(64).dll

libcibpdfux(64).so

libcibpdfux(64).sl

CIB pdf toolbox-DLL for Win, interface for application

Library for the CIB pdf toolbox

Include Datei for the CIB pdf toolbox

Access Dll for CSV files

Access Dll für XML files

Tool Dll for XML

Tool Dll XML

Tool Dll XML

Tool Dll for JBIG2 images

CIB pdf toolbox shared library for diverse Unix Systems

CIB pdf toolbox shared library for HP Unix Systems

Dependend Libraries on Linux/Unix

libgcc_s.so

libstdc++.so.6

Dependend Libraries on AIX

libgcc_s.a

libstdc++.a

FlattenFormfields

String

If this property is set "1", the form fields are removed, but the optical "view" of these form fields is maintained. Possible values:

„0“: Nothing will be done. (default)

„1“: All form fields are removed, but the visual "view" of these form fields is retained.

However, only form fields that are also visible on the screen remain visible. For example, if a form field is only visible when printing, it will not be visible after calling FlattenFormfields.

Furthermore, all visual effects caused by JavaScript are not visible either. The view after calling "FlattenFormfields" is the same like if viewing with a PDF viewer with deactivated JavaScript.

If OutputFormat=FormatText, the content of the form fields is written to the text output.

Set

PdfAFallback

(from CIB pdf toolbox 1.12.0 onwards)

String

Controls whether, if an error occurs during PDF/A conversion, the page concerned is automatically converted as an image via CIB renderer.

Possible values:

„0“   If an error occurs during PDF/A conversion a return value is set (default).

„1“   If an error occurs, the corresponding page is converted as a graphic via CIB renderer.

Set

PdfVersion

String

Setting the PDF version to be generated.

Valid values:

„PDF/A-1b“                 Due to ISO 19005-1

„PDF/A-2b“                 Due to ISO 19005-2

„PDF/A-3b“                 Due to ISO 19005-3

Get/Set

SkipPageXmpCheck

(from CIB pdf toolbox 1.20.0 onwards)

String

This property can be used to control the handling of the XMP metadata present in PDF at page level during PDF/A conversion.

Possible values:

0        Default
All existing XMP metadata in PDF will be removed and replaced in the PDF/A output at document level by XMP metadata with default values.

1        The XMP metadata existing at page level is transferred to the PDF/A output without being checked. In this case, the user is responsible for ensuring that the data is PDF/A compliant.

Set

ImagePdfCreationPreserveText

(from CIB pdf toolbox 1.21.0 onwards)

String

This property can be used to control that in case of a PDF/A fallback (PdfAFallback=1, for details see description of PdfAFallback property), the data will be extracted and embedded in the generated PDF/A.

The text content will be extracted from the PDF, converted to HOCR format and embedded as HOCR in the PDF/A file.

Possible values:

0            Default
No text extraction

1            Text extraction and embedding in PDF/A

Set

SignPdf

String

Property, to activate signing of the output PDF.

Possible values:

„0“       No signing (default)

„1“       PDF will be signed

Any signatures contained in the input PDFs are deleted by default.

If SignPdf=1, NeedAppearances=0 has to be set. (Then the field "/NeedAppearances" will be set “false” in the PDF document.) Otherwise the generated signature will not be visible in the Adobe signature window.

Set

SignPdf.DocMDP

String

The signature gets the type „DocMDP“ (author signature).

This means that only changes that have been allowed exexplicitly by the author will be made in the PDF afterwards. Other changes invalidate the signature.

Requirements: SignPdf=1 and the output file PDF version is higher or equal to 1.5.

Possible values:

„“    No DocMDP signature (default)

„1“   No changes allowed

„2“   Allows signing, filling in form fields and creating new pages from page templates:

„3“   Allows same processes as in“2”,
but additionally all changes in comments

Otherwise: no DocMDP signature

Note: documents with DocMDP signature can only be read by Adobe Reader 7.0 onwards.

Set

SignPdf.Lock

String

The signature gets the lock type. This means that no changes to form fields are allowed and visible signatures can no longer be added. Requirements: SignPdf=1, SignPdf.DocMDP is not set, and PDF Version of the output is higher or equal to 1.5.

Possible values:

„0“   No lock for the document (default)

„1“   Document will be locked as described above. This corresponds to the "Lock Document After Signing" option in Adobe Professional. The Adobe Reader displays: ”The document is locked by that signature”.

Set

CertificateFilename

String

Setting the name (with path if necessary) of the certificate file. This must be a PKCS12 certificate file (usual ending ".p12" or ".pfx").

The signature via PEM files is not available yet. There was no suficient testing yet. Multiple PEM files can be specified. They need to be separated by the “;” symbol. All files have to be togheter with only one private key, Additionally, they need to contain the public key and the (optinal) key string of the signer. If a PEM file contains more private keys, the first one that fits to “CerficatePassword” will be used.

Set

CertificatePassword

String

Setting the password for the certificate file.

Set

RemovePdfSignatures

String

This property is used to control if existing signatures in the input files will be deleted.

Possible values:

„0“     Signatures will not be removed.

„1“     All signatures will be removed

There is a different standard behavior:

When signing (SignPdf=1), RemovePdfSignatures=1 is default.

Otherwise (and thus also during verification, CheckPdfSignatures=1) RemovePdfSignatures=0 is default.

Set

RemovePdfSignaturesKeepAppearance

String

This property will only be used whether RemovePdfSignatures=1 or SignPdf=1 is set.

Possible values:

„0“     When removing the signature, also the visible part of the signatures will be removed. (default)

„1“     When removing the signature, the visible part of the signatures will be maintained (e.g. image or text). But the signature will be removed.

Set

CheckPdfSignatures

String

This property controls whether signatures present in the input files are verified or not.

Possible values:

„0“     No signature will be verified (default)

„1“       All signatures will be verified.

Set

TrustedCertificatesDirectory

String

Directory containing the trusted certificates (with the public keys) for the CIB pdf toolbox.

This directory is mandatory for checking the trustworthiness of the signature certificates in the PDF document with CheckPdfSignature=1.Default: ””.

If this property is empty, it is not possible to verify if the signature certificates are trustworthy. But the verification of the signature is still not aborted!

The following certificate files with public keys are supported:           

-         CER files („.cer“) in DER and Base64 encoding

-         CRT files („.crt“) in DER and Base64 encoding

-         PEM files („.pem“)

-         P7B files („.p7b“) in DER encoding

-         P7C files („.p7c“) in DER encoding

-         SPC files („.spc“) in DER encoding

Files with other extensions will be ignored. The certificate files should only contain public keys.

Set

OutputFormat

String

The verification behavior (i.e. only with CheckPdfSignature=1) of the CIB pdf toolbox is controlled by the assignment of the "OutputFormat" property. A new value "FormatAnalyse" was introduced for this purpose. OutputFormat=”FormatAnalyse”

The verification process is always executed completely and the SignedDocument.xxx properties are set for the signature. This allows to track which processing steps were successful and which not.
 

-         OutputFormat not equal to “FormatAnalyse”

As soon as the signature of an input file is not valid, the processing will be aborted with an error and therefore, none of the SignedDocument.xxx properties will be set.
The SignedDocument.xxx properties will only be set if processing is successful.

Set

SignedDocument.DocumentIsUnmodified

String

The change status for each input PDF will be given.
(Only relevent if OutputFormat=“FormatAnalyse“ and CheckPdfSignatures=”1”)

A value will be given for each input file in form of a list, separated by the ; symbol.
E.g..: „1;0;no signature“.

Possible values:

“”    Not used by CIB pdf toolbox   (default)

“1”   The document has not been changed after signing.

“0”   The document has been changed after signing.

“not implemented”  This functionality has not been implemented.

“no signature”  The PDF does not contain any signature.

Get

SignedDocument.DocumentModificationsAreAllowed

String

For each input PDF, any changes made are classified.
(Only relevant for

OutputFormat=“FormatAnalyse“ and CheckPdfSignatures=”1”)

For every input data there will be given a value in form of a list, values separated by ; symbol

E.g.: „1;0;no signature“.

Attention:
This property is not fully implemented yet, so the value "not implemented" can occur often.

Possible values:

“”    Not used by CIB pdf toolbox   (default)

“1”   The document has not been changed after signing.

“0”   The document has been changed after signing.

“not implemented”  This functionality has not been implemented.

“no signature”  The PDF does not contain any signature.

Get

SignedDocument.DocumentSignatureDateIsValid

String

Only signature date will be verified for each input PDF.

(Only relevant for OutputFormat=“FormatAnalyse“ and CheckPdfSignatures=”1”)

For every input data there will be given a value in form of a list, values separated by ; symbol

E.g.: „1;0;no signature“.

Possible values:

“”    Not used by CIB pdf toolbox   (default)

“1”   The document has not been changed after signing.

“0”   The document has been changed after signing.

“not implemented”  This functionality has not been implemented.

“no signature”  The PDF does not contain any signature.

Get

SignedDocument.CertificateChainIsValid

String

For each input PDF it will be verified whether the certificate chain is valid throughout.
(Only relevant for OutputFormat=“FormatAnalyse“ and CheckPdfSignatures=”1”)

For every input data there will be given a value in form of a list, values separated by ; symbol

E.g.: „1;0;no signature“.

Possible values:

“”    Not used by CIB pdf toolbox   (default)

“1”   The document has not been changed after signing.

“0”   The document has been changed after signing.

“not implemented”  This functionality has not been implemented.

“no signature”  The PDF does not contain any signature.

Get

SignedDocument.CertificateIsTrusted

String

For each input PDF the trustworthiness of the signatures will be verified.

(Only relevant for OutputFormat=“FormatAnalyse“ and CheckPdfSignatures=”1”)

For every input data there will be given a value in form of a list, values separated by ; symbol

E.g.: „1;0;no signature“.

Possible values:

“”    Not used by CIB pdf toolbox   (default)

“1”   The document has not been changed after signing.

“0”   The document has been changed after signing.

“not implemented”  This functionality has not been implemented.

“no signature”  The PDF does not contain any signature.

Get

Attached file does not have any password.

Attached file has an owner password.

Attached file has owner and user password.

Main file has no password.

Output file has no password.

Output file has the password in the attached file.

Output file has the password in the attached file.

Main file has an owner password.

Output file has the owner password of the main file.

Output file has owner password of the main file.

Output file has owner password of the main file.

Main file has owner and user password.

Output file has owner and user password of the main file.

Output file has owner and user password of the main file.

Output file has owner and user password of the main file.

AllowPdfPermissions

(from CIB pdf toolbox 1.8.3 onwards)

String

The property can be used to decide if the editing rights set in the PDF via the owner password are taken into account during processing.

Attention:

Any user password assigned in the PDF must be set, otherwise no processing will take place.

The generated output PDF is not encrypted.

1          Rights will be ignored

0          Rights will be taken into account

          (default)

This property must be set to the value "1" when converting a PDF/A file protected with an owner password. Otherwise it will result in an error.

Set

EncryptDocumentPassword

(from CIB pdf toolbox 1.18.0 onwards)

String

This property can be used to pass the password for a password-protected document without specifying whether it is an EncryptUserPassword or EncryptOwnerPassword.

The syntax is identical to that of these two properties.

If the EncryptDocumentPassword is set, the CIB pdf toolbox will detect which password is used (User or Owner).

For the feedback of this information the PDFPERMISSION (= SECURITYINFO) metadata has been extended by the flag IsOwnerAccess:
1          Owner-Passwort
0          User-Passwort

Attention:
The SECURITYINFO metadata will only be set for encrypted documents. If they are not available, the document is unprotected.

Set

EncryptOwnerPassword

String

Owner password of the input file(s) or BackgroundFilename.

The passwords have to be listed in exactly the same order as the corresponding files within the InputFilename /BackgroundFilename (separated by ; symbol).

The password itself cannot contain the ; symbol.

Set

EncryptUserPassword

String

User password of the input file(s) or BackgroundFilename.

The passwords have to be listed in exactly the same order as the corresponding files within the InputFilename /BackgroundFilename (separated by ; symbol).

The password itself cannot contain ; symbol.

Set

OutputOwnerPassword

String

Assigns new owner password for the output file.

The password itself cannot contain ; symbol.

Set

OutputUserPassword

String

Assigns a new user password for the output file.

The password itself cannot contain ; symbol.

Set

PdfUserPasswordPresent
(from CIB pdf toolbox 1.4.78 onwards)

String

Possible values:

„“ or „0“ = no user password available

“1” = user password available

Get

PdfOwnerPasswordPresent
(from CIB pdf toolbox 1.4.78 onwards)

String

Possible values:

„“ or „0“ = no owner password available

“1” = owner password available

Get

PdfVersion

String

Setting the PDF version to be generated.

Valid values:

“1.3”                Acrobat family 4

“1.4”                Acrobat family 5 (default)

“1.5”                Acrobat family 6

“1.6”                Acrobat family 7

„1.7“                Acrobat family 8

From CIB pdf toolbox Version 1.4.109 onwards:
“1.7EL3“           Acrobat family 8
(Acrobat Reader version 9 or higher          is required to open it!)

Hint:
When encryption is enabled, the following encryption algorithms are used:
”1.3”                RC4-40, Revision 2
”1.4”                RC4-128, Revision 3
”1.5”                RC4-128, Revision 4
from “1.6”        AES-128, Revision 4
from „1.7EL3“ AES-256, Revision 5

Get/
Set

EncryptMetadata

(from CIB pdf toolbox 1.4.109 onwards)

String

By setting this property, the user can decide if the metadata will be encrypted in the PDF. Metadata is general information about the PDF, such as author, creation date, and so on. The format and content of the metadata is not fixed and depends on the tool that created the PDF.

Possible values:
„0“       No metadata encryption
„1“       Metadaten encryption
            (default)

Hint:
PDF version of at least 1.5 is required to process this property.

Get/
Set

The settings of the following Encryptxxx properties (permissions) are generally transferred to the output document with the password from the input. See chapter "How does the CIB pdf toolbox behave with password protection?

For unencrypted input, all switches in the output are set TRUE.

If a new password (OutputOwnerPassword, OutputUserPassword) is assigned to the output document, the permissions can be reassigned by setting the following Encryptxxx properties.

EncryptEnableAssembling

String

Approve document assembly for the output file.

Possible values:
“1“ or „TRUE“   approved
“0“ or „FALSE“  not approved  

Set

EncryptEnableClipboard

String

Approve content copying for the output file.

Possible values:
“1“ or „TRUE“   approved
“0“ or „FALSE“  not approved 

Set

EncryptEnableExtract

String

Screen reader programs (e.g. for the visually impaired) can access the content. The user is not allowed to copy text and graphics from the PDF file if this value is set.

Possible values:

„0“       No permission (default)

„1“       Action permitted

Set

EncryptEnableForms

String

Approve completion of form fields for the output file.

Possible values:
“1“ or „TRUE“   approved
“0“ or „FALSE“  not approved 

Set

EncryptEnableModifying

String

The user may modify the PDF file (add text etc.) if this value is set.

Possible values:

„0“       No permission (default)

„1“       Action permitted

Set

EncryptEnableNotes

String

The user may add text notes and AcroForm fields to the PDF file and modify existing ones if this value is set.

Possible values:

„0“       No permission (default)

„1“       Action permitted

Set

EncryptEnablePrinting

String

Approve printing for the output file.

Possible values:
“1“ or „TRUE“   approved
“0“ or „FALSE“  not approved 

Set

PdfEncryptionLevel
(from CIB pdf toolbox 1.4.78 onwards)

String

Returns the encryption depth, which is greater or equal to 40 and always a multiple of 8.

Get

PdfEncryptionAlgorithm
(from CIB pdf toolbox 1.4.78 onwards)

String

Returns the value of the encryption algorithm.

„0“ = undocumented algorithm

„1“ = PDF encryption 40 bit (RC4-40)

„2“ = PDF encryption, 40 bit oder higher (RC4-128)

„3“ = undocumented algorithm

From CIB pdf toolbox 1.4.107 onwards:

„4“ = AES-128

From CIB pdf toolbox 1.4.109 onwards:

„5“ = AES-256

User-defined encryption is possible for cases "4" and "5". This refers to the feature "Metadata unencrypted" offered by Adobe Acrobat.

Get

PdfPermissionAssemble
(from CIB pdf toolbox 1.4.78 onwards)

String

Possible values are:

„“ = swap pages, create bookmarks and thumbnails allowed

„NotAllowed” = swap pages, create bookmarks and thumbnails not allowed

Get

PdfPermissionContentAccess
(from CIB pdf toolbox 1.4.78 onwards)

String

Possible values are:

„“ = cutting text and graphics is allowed

„NotAllowed” = cutting text and graphics is not allowed

Get

PdfPermissionCopy
(from CIB pdf toolbox 1.4.78 onwards)

String

Possible values are:

„“ = copying text and graphics is allowed

„NotAllowed” = copying text and graphics is not allowed

Get

PdfPermissionFillFormFields
(from CIB pdf toolbox 1.4.78 onwards)

String

Possible values are:

 „“ = filling in form fields, including signature fields, is allowed

„NotAllowed“ = filling in form fields, including signature fields, is not allowed

Get

PdfPermissionModify

(from CIB pdf toolbox 1.4.78 onwards)

String

Possible values are:

„“ = modification is allowed (bit 3 is set or document is not encrypted)

„NotAllowed“ = modification is not allowed (bit 3 is not set)

Get

PdfPermissionModifyAnnotations

(from CIB pdf toolbox 1.4.78 onwards)

String

add or modify text annotations and (if modify permission is true) form fields

Possible values are:

„“ = Modification of annotations is allowed (bit 5 is set or document is not encrypted)

„NotAllowed“ = Modification of annotations is not  allowed
(bit 5 is not set)

Get

PdfPermissionPrint
(from CIB pdf toolbox 1.4.78 onwards)

String

Possible values are:

„“ = Printing allowed

„NotAllowed“ = Printing not allowed

„Low Resolution“ = Printing only in low resolution allowed

Get

PdfPermissions

String

Bit field as decimal number, permitted access types without master password

Get

PageCount:

Number of pages in the document

PageCount:

Number of pages in the document

DocInfo.Author:

Author

DocInfo.Title:

Title

DocInfo.Subject:

Subject

DocInfo.Keywords:

Keywords

DocInfo.CreationDate:

Creation date

DocInfo.ModDate:

Modification date

PdfPermissionAssembly:

Swap pages, generate bookmarks and thumbnails is (not) allowed

PdfPermissionContentAccess:

Cutting text and graphics (not) allowed

PdfPermissionCopy:

Copying text and graphics (not) allowed

PdfPermissionFillFormFields:

Filling in form fields, including signature fields, is not allowed

PdfPermissionPrint:

Printing (not) allowed

OutlinesDeleteExisting

String

Remove all outlines or bookmarks from input documents.

Possible values:

„0“: The existing outlines will not be removed. (default)

„1“: All existing outlines will be removed.

Set

OutlinesAdd

String

Adding new outlines and bookmarks to the output PDF document. If bookmarks already exist and should be kept (i.e. OutlinesDeleteExisting=0), the new bookmarks are added to the existing ones.

Possible values:

„ “: No outlines will be added. (default)

A non-empty string: The outlines specified in this property are inserted into the output PDF.                                                        If the syntax is incorrect: error code 349 (CIBPDF_ERROR_OUTLINES_ADD_WRONG_FORMAT)
 

Syntax:

<outlinelist> ::= <outline> | <outline> “;” <outlinelist>

<outline> ::= <outline-with-descendants> | <outline-without-descendants>

<outline-with-descendants> ::= “{” <page> “;{” <destination> “};” <outlinetext> “;{” <outlinedescendants> “}}”

<outline-without-descendants> ::= “{” <page> “;{” <destination> “};” <outlinetext> “}” | “{” <page> “;{” <destination> “};” <outlinetext> “;{}}”

<page> ::= <Integer>

<outlinetext> ::= <text>

<outlinedescendants> ::= <outlinelist>

<destination> ::= <XYZ> | <Fit> | <FitH> | <FitV> | <FitR> | <FitB> | <FitBH> | <FitBV>

<XYZ> ::= „XYZ“ „;“ <Integer> „;“ <Integer> „;“ <Integer>

<Fit> ::= “Fit”

<FitH> ::= “FitH” “;” <Integer>

<FitV> ::= „FitV“ „;“ <Integer>

<FitR> ::= „FitR“ „;“ <Integer> „;“ <Integer> „;“ <Integer> „;“ <Integer>

<FitB> ::= „FitB“

<FitBH> ::= „FitBH“ „;“ <Integer>

<FitBV> ::= „FitBV“ „;“ <Integer>

See next sections for details and examples.

Set

(from CIB pdf toolbox 1.10.0 onwards)

Property returns a string with identical structure.

Get

XYZ

XYZ;number1; number2;
number3

The specified page is displayed so that the x-y coordinate (number1;number2) of the page is at the top left of the window. Number3 is the zoom factor for the page (e.g. Number3=1 is a zoom of 100%, Number3=2 is a zoom of 200%, etc.). Especially number3=0 means that the current zoom factor remains unchanged.

Fit

Fit

The specified page will be enlarged so much that the page fills the window exactly. If this is not possible exactly, the page is enlarged so that the page is always completely visible in the window. One dimension of the page then fills the window exactly. The other dimension of the page is then smaller than the window and is centred within the window.

FitH

FitH;number1

The specified page is displayed so that the y-coordinate number1 of the page is displayed exactly at the top of the window. At the same time, the page is enlarged so that the width of the page fills the window exactly.

FitV

FitV; number1

The specified page is displayed so that the x-coordinate number1 of the page is displayed exactly on the left edge of the window. At the same time, the page is enlarged so that the height of the page fills the window exactly.

FitR

FitR; number1; number2;
number3; number4

The values (number1;number2;number3;number4) are the coordinates of a rectangle within the page (x-value-left;y-value-bottom;x-value-right;y-value-top). The page is displayed and enlarged so that this rectangle fills the window exactly. If this is not possible exactly, the page is enlarged so that the rectangle is always completely visible in the window. One dimension of the rectangle then fills the window exactly while the other dimension of the rectangle is smaller than the window and is centered within the window.

FitB

FitB

The specified page is enlarged so that the page's bounding box exactly fills the window. If this is not possible, the page is enlarged so that the page's bounding box is always completely visible in the window. One dimension of the bounding box then fills the window exactly while the other dimension of the bounding box rectangle is smaller than the window and is centered within the window.

FitBH

FitBH;number1

The specified page is displayed so that the y-coordinate number1 of the page is displayed exactly at the top of the window. At the same time, the page is enlarged so that the width of the page's bounding box fills the window exactly.

FitBV

FitBV;number1

The specified page is displayed so that the x-coordinate number1 of the page is displayed exactly at the left edge of the window. At the same time, the page is enlarged so that the height of the page's bounding box fills the window exactly.

BarcodeRange

String

This property contains a list of barcode types separated by semicolons. All images in the PDF are checked to see if they are barcodes of the specified types. The search can also be restricted to areas of the PDF.

Syntax:

<barcoderangelist> ::= <barcodetypes> | <barcoderanges>

<barcoderanges> ::= <onebarcoderange> | <onebarcoderange> “;” <barcoderanges>

<onebarcoderange> ::= “{” <pagenumber> “}” | “{” <pagenumber> “;” <barcodetypes> “}” | “{” <pagenumber> “;” <barcodetype> “;” <rangeleft> “;” <rangebottom> “;” <rangeright> “;” <rangetop> “}”

<pagenumber> ::= <Integer>

<barcodetypes> ::= <onebarcodetype> | <onebarcodetype> “,” <barcodetypes>

<onebarcodetype> ::= “DataMatrix” | “Code128” | “CodeITF” | “Code39” | “Code39Extended” | “QR”

<rangeleft> ::= <Integer>

<rangebottom> ::= <Integer>

<rangeright> ::= <Integer>

<rangetop> ::= <Integer>

<rangeleft>, <rangebottom>, <rangeright>, <rangetop> are positive integers in mm, origin (0;0 is the lower left corner of the PDF page.

„ “: (Property is empty) All images of the PDF are checked for barcode information and this is done with the two barcode types "QR" and "DataMatrix". (default)

Incorrect assigning of the property results in returning error code 100.

See below for examples.

Set

BarcodeInfo

String

The retrieved barcode information is returned to this property.

If an output file (OutputFilename) and a memory area (MemoryOutputCallback) are specified, the output is sent to this file and also to memory.

Hint:
If you enter individual specifications (output file or memory area) or no specifications at all, the value for BarcodeInfo is not set at all.

If no barcode is found in the specified area, the property/output file remains empty.

The format of the output depends on the contents of the OutputFormat property. Possible are OutputFormat= FormatBarcodeXml /FormatBarcodeCsv.

The coordinate origin (0;0) is the lower left corner of the PDF page.

OutputFormat=FormatBarcodeXml :

<barcodeimagexml> ::= <empty value> | „<?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?><barcodeimages>“ <barcodeimagelist> „</barcodeimages>“

<barcodeimagelist> ::= <onebarcodeimage> | <onebarcodeimage> <barcodeimagelist>

<onebarcodeimage> ::= „<barcodeimage><pagenumber>“ <pagenumber> „</pagenumber><left>“ <imageleft> „</left><bottom>“ <imagebottom> „</bottom><right>“ <imageright> „</right><top>“ <imagetop> „</top><barcodeinfos>“ <barcodeinfolist> „</barcodeinfos></barcodeimage>“

<pagenumber> ::= <Integer>

<imageleft> ::= <Integer>

<imagebottom> ::= <Integer>

<imageright> ::= <Integer>

<imagetop> ::= <Integer>

<barcodeinfolist> ::= <onebarcodeinfo> | <onebarcodeinfo> <barcodeinfolist>

<onebarcodeinfo> ::= „<barcodeinfo type=”“ <barcodetype> „”“ <barcodecontent> „</barcodeinfo>“

<barcodetype> ::= „DataMatrix“ | „Code128“ | „CodeITF“ | „Code39“ | „Code39Extended“ | „QR“

<barcodecontent> ::= <Text>

OutputFormat=FormatBarcodeCsv:

<barcodeimagecsv> ::= <empty value> | <barcodeimagelistcsv>

<barcodeimagelistcsv> ::= <onebarcodeimagerow> | <onebarcodeimagerow> <barcodeimagelistcsv>

<onebarcodeimagerow> ::= <pagenumber> „;“ <imageleft> „;“ <imagebottom> „;“ <imageright> „;“ <imagetop> „;“ <barcodeinfolistcsv> <CR> <LF>

<pagenumber> ::= <Integer>

<imageleft> ::= <Integer>

<imagebottom> ::= <Integer>

<imageright> ::= <Integer>

<imagetop> ::= <Integer>

<barcodeinfolistcsv> ::= <onebarcodeinfocsv> | <onebarcodeinfocsv> „;“ <barcodeinfolistcsv>

<onebarcodeinfocsv> ::= „;“ | <barcodetype> „;“ <barcodecontent>

<barcodetype> ::= „DataMatrix“ | „Code128“ | „CodeITF“ | „Code39“ | „Code39Extended“ | „QR“

<barcodecontent> ::= „““ <Text> „““

Hints regarding CSV:

• If the original barcode text contains a quotation mark ", this is replaced in CSV format by two consecutive quotation marks "".
• Every barcode image has its own "<onebarcodeimagerow>" line. If a PDF image consists of image and mask and should both contain barcode information, they are entered as two "<onebarcodeimagerow>" lines with the same page number and the same legal area
• For every barcode image, the barcode information for different barcode types is specified at the end, separated by the semicolon. First the bar code type and then the bar code content is specified for each bar code info
• To ensure that each CSV line consists of the same number of columns (separated by a semicolon), a corresponding number of ";;" is appended at the end of each CSV line (= <onebarcodeimagerow>).

See below for examples

Get

OCRDebug

String

This property is only relevant for technical test purposes. It controls the output of images from the PDF.

Possible values:

„1“     The intermediate steps of barcode extraction using OCR get individual output files.

„0“     No output for intermediate steps. (default)

For every single image in the PDF document, which was transferred to the CIB Ocr Dll, the outputs are several files:

• The image itself as a bitmap as it was passed to OCR.
• The barcode result of the CIB Ocr Dll, if the barcode result is not empty. If the bar code result is empty, there is no output for this file.

The files are written to the same directory as the output file. The names of these files have the following form:

“output-file”__Page_”page-number”_Image_“image-number“_“file-extension“

The following applies to the "file extension“:

• For bitmap file: „.bmp“
• For the barcode result of CIB Ocr Dll: „_BARCODE.txt“

Example:
If the output file is called „Output.xml“, there will be the following files for the 4. image of the 3^rd page:
Output.xml__Page_3_Image_4.bmp
Output.xml__Page_3_Image_4_BARCODE.txt

Set

BarcodeRecognitionMode

String

This property controls which method of barcode recognition is to use.

"RecognizeImages": The original method is used. CIB pdf toolbox provides separate image objects to CIB ocr for recognition. (default)

"RecognizePages": CIB pdf toolbox provides complete page images to CIB ocr for recognition.

Note:

Using RecognizePages could be slower than the original method since complete image for page should be recognized.

Property description

Functionality

Kind

PdfLayers

Syntax:

PdfLayers={"RequestedStates":[{"LayerId":<Id1>,"State":"On"/"Off"},..., {"LayerId":<IdN>,"State":"On"/"Off"}]}

where:

Id1...IdN are numeric IDs of the optional content layers, and the layer state is "Off" (invisible), or "On" (visible)

Notes:
After the first processing of a PDF file, an outer application can get info about the existing OC groups for the Default configuration from the output property PdfLayersInfo.

After knowing this info, the outer application can request arbitrary states (visible/not visible) for any OC layers.

Set

PdfLayersInfo

The output property outputs info about the existing optional content layers and their states.

Syntax:

PdfLayersInfo={"Tree":[<LayerDescription>], "PageLayers":[<PageLayersDescription>]}

where:

Tree is an array, describing hierarchical structure of the existing layers in PDF.

Tree contains the items: <LayerDescription> which is a description of each layer:

{"Name":"<LayerName>", "LayerId":<Id>,"Locked":true/false, "State":"On"/"Off", "RBGroups":[<RBId1>,...<RBIdN>],"Kids":[ <LayerDescription> ]}

where:

"LayerId": <Id> is unique number, (layer identifier that should be used for input property PdfLayers).

Locked: true/false shows if an user can switch the current state of the layer.

Kids: array, describing all kids of the layer.

PageLayers is an array of pages and their layers:

PageLayersDescription = {"PageIndex":<PageId>, LayerIds:[<LayerId>]}

 <PageId> is an index of a page, starting from 0

LayerIds is an array of <LayerId> (numeric id) that could be mapped to appropriate LayerIds from Tree object.

Note:

1. If LayerDescription contains only Name and Kids (no LayerId and State entries), then it is not a real Layer, but simple node that can be expanded or collapsed and it contains other layers. If LayerDescription contains all entries and also has Kids, then the Layer is a node, which can be switched to On or Off, and also contains other layers.
2. New action of type SetOcgState is additionally output into the metafile to allow OCG switching with using form fields and widget annotations.
3. The output property PdfLayersInfo will be also filled for OutputFormat=FormatInfo with appropriate FilterInfo.

Get

OutputFormat

String

FormatSearchablePdf

Set

CurrentProgress

(from CIB pdf toolbox 1.24.0 onwards)

String

This property can be used to check the progress of the text recognition process of CIB ocr.

The CIB pdf toolbox transfers the content of the method CibOcrJobGetProgress of the CIB ocr module unchanged.

The property contains a string with the structure:
<current page number> <total page number> <processing progress for current page >

For details see „Technical manual CIB ocr“, chapter „CibOcrJobGetProgress“

Get

DictionaryWorkSpace

String

This property allows to set the path for the data required by CIB ocr.

Set

FormatSearchablePdfShowText

String

It can be definied whether the text inserted in the output PDF is visible or not.

„1“       Text is visible

„0“       Text is not visible (default)

Set

FormatSearchablePdfRemoveImages

String

It can be defined whether the images are removed from the output PDF or not.

Setting this property is only possible if "HocrInputData" is empty and is only useful in conjunction with "FormatSearchablePdfShowText=1". Then the images are replaced by visible text in the output PDF.

„1“       Images will be removed

„0“       Images will be maintained (default)

Set

PdfVersion

(from version 1.6.116b onwards)

String

The PdfVersion property can also be set optionally for OutputFormat=FormatSearchablePdf. Then the created PDF corresponds to the specified PDF/A standard.

Note: this is currently only supported in combination with FormatSearchablePdfShowText=0.

Possible values:

PDF/A-1b

PDF/A-2b

PDF/A-3b

Set

HocrInputData

(from version 1.9.0, multi page format from 1.10.0 onwards)

String

This string gives the possibility to import the hocrdata directly from the toolbox (instead of extracting them from the images of the PDF document). If this string is empty (default), it will not be used.

Otherwise it includes a list of memory addresses and lengths for strings containing the hocrdata. It must be in the following format:

Syntax:

HocrInputData ::= <OneHocrFile> [“;“ <OneHocrFile>] ...

OneHocrFile ::= “{” <Pagenumber> “};” <MemoryBlocks>

MemoryBlocks ::= [<MemoryBlocks-Delimiter> “;”] <MemoryBlock> [<MemoryBlocks-Delimiter> <MemoryBlock>] ...

MemoryBlock ::= <Address> <MemoryBlock-Delimiter> <Length>

MemoryBlock-Delimiter ::= An individual symbold that is not equal to ‚;‘ and ‚\0‘, e.g. ‚#‘ or ‚?‘, better not to use numbers or characters either.

Pagenumber ::= Page number of the page for which the hocrdata are specified.

Address :== A decimal number that specifies the address of a memory block for the hocrdata.

Length ::= A decimal number that specifies the length of a memory area for the hocrdata.

Example:

HocrInputData=“{1};?;111?100?222?200;{2};113?100;{3};+;300+100+400+200“ means:

Page 1 has hocr data in the memory areas (address, length) (111, 100) and (222, 200); page 2 has hocr data in the memory areas (113, 100); page 3 has hocr data in the memory areas (300, 100) and (400, 200).

From CIB pdf toolbox 1.10.0 onwards. a multi-page format is also possible:

If the first character is not equal to "{", only one XML HOCR file is specified. This can consist of several individual XML HOCR pages. The file has to be in a special format, such as generated by CIB format with the property OutputFormat=FormatHocr.

Set

HocrOutputFilename (from version 1.9.0 onwards)

String

If the string is empty, no hocr data is written out (default).

If the string is not empty, all used hocr data will be written in the file with this filename as multi-hocr file.

The line "<!-- CIB:page=page number -->" is written before each individual "hocr part", where "page number" is the page number for the hocr part. (e.g. "<!-- CIB:page=3 -->" = Hocrdata for page 3). Texts like 'CIB ocr testlicense' are removed from the hocr parts.

Set

OCRDebug

String

This property is only relevant for technical test purposes. It controls the output of images from the PDF.

Possible values:

„1“     The intermediate steps of barcode extraction using OCR are output as individual files.

„0“     No output of intermediate steps (default)

For every single image in the PDF document, which was transferred to the CIB Ocr Dll, several files are output:

• The image itself as a bitmap as it was passed to OCR.
• The barcode result of the CIB Ocr Dll, if the barcode result is not empty .If the bar code result is empty, there will be no output for this file.

The files are written to the same directory as the output file. The names of these files have the following form:

“output-file”__Page_”page-number”_Image_“image-number“_“file-extension“

For the “file extension” applies:

• For bitmap file: „.bmp“
• For the barcode result of CIB Ocr Dll: „_BARCODE.txt“

Example:

If the output document is "Output.xml", the following files are output for the 4th image of the 3rd page:

Output.xml__Page_3_Image_4.bmp
Output.xml__Page_3_Image_4_BARCODE.txt

Set

FormatSearchablePdfTextColor

(from version 1.10.0 onwards)

String

This property is only used if OutputFormat=FormatSearchablePdf and FormatSearchablePdfShowText="1" and the first character of HocrInputData is not equal to '{'. It specifies the color for the inserted text.

Possible values:

• empty String (default): black will be used as standard font color.
• The text color is given in the form "R;G;B", where R, G and B are natural decimal numbers between 0 and 255. (R is the red component, G is the green component and B is the blue component).

For example, "255;0;0" is red.

Set

FormatSearchablePdfLayerName

(from version 1.10.0 onwards)

String

This property is only used if OutputFormat=FormatSearchablePdf and FormatSearchablePdfShowText="1" and the first character of HocrInputData is not equal to '{'.

It indicates (if specified) the PDF layer name (in Adobe Reader) for the inserted text.

Possible values:

• Empty String (default): The inserted text is not part of any PDF layer.
• The inserted text is part of the Pdf layer with this layer name.

Set

FormatSearchablePdfDTDFolder

(from version 1.10.0 onwards)

String

This property is only used if OutputFormat=FormatSearchablePdf and FormatSearchablePdfShowText="1" and the first character of HocrInputData is not equal to '{'.

It is an auxiliary property and specifies (if specified) the local path for the XHTML DTD file xhtml1-transitional.dtd. The background is: The XML parser returns a NetAccessorException. And the W3C says that the calls to the DTDs should be stored locally.

Possible values:

• Empty String (default): Nothing will be done.
• The URL for xhtml1-transitional.dtd in the HOCR-XML-file of HocrInputData is replaced by a reference to the local file of the same name.

Set

FormatSearchablePdfConversionMode

(from version 1.18.0 onwards)

String

This property defines the form in which the images contained in the PDF are transferred to CIB ocr..

Possible values:

FormatSearchablePdfConvertImages
The previous behavior is applied, i.e. each image on a page is treated as a separate object.

FormatSearchablePdfConvertPages
Each page is converted into a single image and passed to CIB ocr. The resolution of this image can be controlled by the property TiffResolution (recommended values are TiffResolution=150 and higher).

FormatSearchablePdfConvertAuto
On pages that contain only a single image, the previous behavior is applied. On all other pages the behavior of „FormatSearchablePdfConvertPages“. (Default)

Set

FormatSearchablePdfUseRotationHint

(from version 1.18.0 onwards)

String

If this property is set, the information about a rotation is passed to CIB ocr for each page of the PDF. This improves the recognition rate of CIB ocr for rotated pages.

For this purpose the CIB pdf toolbox uses the CIB ocr property ImageRotationAngle.

Possible values:

0          Previous behavior

1        Transfer of information about the page rotation to CIB ocr. (Default)

Set

FormatSearchablePdfReplaceText

String

This property is only valid for OutputFormat=FormatSearchablePdf

If the property FormatSearchablePdfReplaceText IS NOT set then the original behavior will be used: pdf toolbox will always add new CIB HOCR content without removing existing ones.

If the property is set as FormatSearchablePdfReplaceText=1 then pdf toolbox will remove existing invisible CIB HOCR content from the processed document before adding a new one.

The new property FormatSearchablePdfReplaceText can also work in conjunction with TextSelectionFilter:

if FormatSearchablePdfReplaceText=1 and TextSelectionFilter contains some filter then this filter will be used to remove text from the original document before adding new HOCR text

Examples:

1. OutputFormat=FormatSearchablePdf FormatSearchablePdfReplaceText=1 - will remove existing CIB HOCR text before adding new HOCR text

2. OutputFormat=FormatSearchablePdf FormatSearchablePdfReplaceText=1 TextSelectionFilter={"groups":["any_invisible"]} - will remove any invisible text (including CIB HOCR) before adding new HOCR text

Type

Variable

Description

char*

a_pOptionName

Name of the desired configuration parameter

void*

a_pOptionValue

Value of the desired configuration parameter

Attention:

Notice the data type of the respective value.

char*

a_pOptionName

Name of the desired configuration parameter

void*

a_pOptionValue

Value of the desired configuration parameter

long

a_lBufferLength

Length of the buffer for the option content

unsigned long &

a_lVersion

a_lVersion returns the current version number of the CIB pdfm component. The unsigned long-value returns the information in two ranges. The first two bytes contain the version counter of the main release. The bytes 3 and 4 contain the corresponding current release counter. Depending on the programming language, the high and low ranges have to be considered accordingly.

long

a_hJob

Handle of the request to be executed

int *

a_iError

Placeholder for the current error code

int

a_iErrorId

error code

char

a_pTextBuffer

Text buffer for the error text

long

a_lBufferLength

Length of the available text buffer

int

a_iError

Place holder for the current error code

int

a_pTextBuffer

Text buffer for the error text

long

a_lBufferLength

Length of the available text buffer

int

pageIndex

Index of the current page (0-based)

size_t

pageWidth
pageHeight

width and height of the current page in pixels and the standard resolution of 72dpi

int

pageIndex

Index of the current page (0-based)

size_t

imageWidth
imageHeight
imageStride

The standard parameters of a bitmap in DIB format

(DIB = device independent bitmap format)

char*

Data

Complete bitmap in DIB format

size_t

imageLength

Their length in bytes

int*

a_iButtonId

Returns the ButtonId of the button clicked within the print selection.

1 (COMOD_ID_OK)      OK button (à you should call CibPrPrint afterwards)

3 (COMOD_ID_CLOSE) Close button (à the user has changed the printer but does not want to print immediately)

2 (CIB_ID_CANCEL)      Cancel button

int*

a_iButtonId

Returns the ButtonId of the button clicked within the print selection.

CIB_ID_OK                                   OK button (à you                                  should call CibPrPrint afterwards)

CIB_ID_CLOSE                              Close button (à the user has changed the printer but does not want to print immediately)

CIB_ID_CANCEL                            Cancel button

int*

a_iButtonId

Returns the ButtonId of the button clicked within the print selection.

CIB_ID_OK                                   OK button (à you                                  should call CibPrPrint afterwards)

CIB_ID_CLOSE                              Close button (à the user has changed the printer but does not want to print immediately)

CIB_ID_CANCEL                            Cancel button

char*

a_TextOutput

The data that is transferred via the callback function.

size_t

a_Length

The number of bytes of the data.

void*

a_pUserdata

Pointer to any user data. Specific type depends on the implementation of the callback function.

Int*

a_Error

Error code which is transferred to the callback function by the caller.

ABORTDOCINFO*

a_AbortDocInfo

The data that is transferred via the callback function.

void*

a_pUserdata

Pointer to any user data. Specific type depends on the implementation of the callback function.

CibPdfJobHandle*

a_pJob

Handle of the request to be executed.

char*

a_pReserved

CibPdfJobHandle*

a_pJob

Handle of the request to be executed.

CibPdfJobHandle*

a_hJob

Handle of the request to be executed.

CibPdfJobHandle*

a_hJob

Handle of the request to be executed.

CibPdfJobHandle*

a_hJob

Handle of the request to be executed.

Int*

a_pButtonID

Returns the ButtonId of the button clicked within the print selection.

1 (COMOD_ID_OK)      OK button (à you should call            CibPrPrint afterwards)

3 (COMOD_ID_CLOSE) Close button (à the user has changed the printer but does not want to print immediately)

2 (CIB_ID_CANCEL)      Cancel button

CibPdfJobHandle*

a_hJob

Handle of the request to be executed

Int*

a_pButtonID

Returns the ButtonId of the button clicked within the print selection.

1 (COMOD_ID_OK)      OK button (à you should call            CibPrPrint afterwards)

3 (COMOD_ID_CLOSE) Close button (à the user has changed the printer but does not want to print immediately)

2 (CIB_ID_CANCEL)      Cancel button

CibPdfJobHandle*

a_hJob

Handle of the request to be executed

Int*

a_pButtonID

Returns the ButtonId of the button clicked within the print selection.

1 (COMOD_ID_OK)      OK button (à you should call            CibPrPrint afterwards)

3 (COMOD_ID_CLOSE) Close button (à the user has changed the printer but does not want to print immediately)

2 (CIB_ID_CANCEL)      Cancel button

CibPdfJobHandle*

a_hJob

Handle of the request to be executed

char*

a_pName

Name of the desired property

void*

a_pValue

Value of the desired property

size_t

a_MaxLength

Buffer length for the option content

CibPdfJobHandle*

a_hJob

Handle of the request to be executed

char*

a_pName

Name of the desired property

void*

a_pValue

Value of the desired property

size_t

a_Length

CibPdfJobHandle*

a_hJob

Handle of the request to be executed

wchar-t*

a_pName

Name of the property in wchar_t* (UNICODE)

wchar-t*

a_pValue

Value of the property in wchar_t* (UNICODE)

size_t

a_MaxLength

The number of bytes of the data

CibPdfJobHandle*

a_hJob

Handle of the request to be executed

wchar-t*

a_pName

Name of the property in wchar_t* (UNICODE)

wchar-t*

a_pValue

Value of the property in wchar_t* (UNICODE)

size_t

a_MaxLength

The number of bytes of the data

CibPdfJobHandle*

a_hJob

Handle of the request to be executed

int*

a_pErrorCode

Placeholder for the current error code

CibPdfJobHandle*

a_hJob

Handle of the request to be executed

char*

a_pText

Text buffer for the error text

size_t

a_MaxLength

Length of the available text buffer

CibPdfJobHandle*

a_hJob

Handle of the request to be executed

AnnotationsFilename

(from CIB pdf toolbox 1.4.105 onwards)

String

Input file or storage area in XFDF format that contains the comments to be imported to the PDF.

This corresponds to the "Import Comments" function in Adobe Acrobat.

Set

AnalysisFilename

(from CIB pdf toolbox 1.14.4 onwards)

String

Writes information about the properties of a PDF page to a log file.

Syntax:
AnalysisFilename=“out.txt“

The analysis file currently only contains information about page size and alignment.

Example:
502;“297mm,210mm;portrait“
502;“297mm,210mm;landscape“

There are 2 pages with the specified dimensions in mm and the alignment portrait and landscape.

This property can be combined with the property OutputFormat=FormatInfo, so that no output file name has to be specified.

Set

AntiAliasing

String

Setting the AntiAliasing fcuntionality.

0     No AntiAliasing (default)

2     x2 AntiAliasing functionality for internal and Pango rendering engine.

4     x4 AntiAliasing functionality for internal and Pango rendering engine. (see also RenderingEngine parameters)

Set

BookmarkAlignment

(from CIB pdf toolbox 1.4.84 onwards)

String

„0“ = No insertion of blank pages

„1“ = Each copy will be extended by blank pages to an even number of pages

Useful for PDF joins without OutputFormat=FormatPrinter only.

Set

CallbackPointer

String

User data of the callback for feedback after each page.

Get/
Set

ColorDithering

(from CIB pdf toolbox 1.4.86 onwards)

String

If this property is set, all color values are converted into black and white patterns when output (as bitmap or when printing). The pattern then is derived from the brightness of the color value.

Possible values:
0          No conversation (default)
1          Conversation to black and white        patterns

Get/
Set

Data

String

Specifies the input data source.

The data is merged in by the PdfMerge module

Syntax:

Data=<file type>:<file name>

<file type>= empty  (CSV will be assumed.)

            CSV
            XML
            ADOBE.XFDF
            TYP

TYP: other file types (e.g. SQL), which are processed via the DataAccess interface.

<file name>=file.typ

            X:\file.typ

            file.xml;//xpath

If the data file (CSV, XML) is a multi-control file, MultiData=1 has to be set.

Example:
Data=ADOBE.XFDF:Input.xfdf

Get/
Set

DataFileMemoryAddresses

String

memory address and length of the data file at memory transfer

Get/
Set

DataFileType

String

data type for data source by memory transfer

Get/
Set

DataXmlPath

String

input request, e.g. „XML:data.xml;//root/...“ for data source by memory transfer

Get/
Set

DataXslFilename

String

name of the XSL transformation file (for transformation of Adobe XFDF form data export)

Get/
Set

DocumentUsedBookmarks

(from CIB pdf toolbox 1.4.105 onwards)

String

Output of the bookmarks used in a document. For each bookmark, the pages it contains are specified. These can be individual pages and/or one or more page areas.

Syntax:
<DocumentUsedBookmarks> ::= < bookmark> | < bookmark> “;” <DocumentUsedBookmarks>

<bookmark> ::= „{“ <text> „;“ <page list> „}“

<page list> ::= <pages> | <pages> „,“ <page list>

<pages> ::= <number> | < number> „-„ < number>

Example:
DocumentUsedBookmarks={AUSF1;1-5};{AUSF3;4,6-7}

Get

EmbeddedFileOutputFormat

String

„None“: the streams of the embedded files are not extracted (Default).

„FormatEmbedded“: the streams of the embedded files are written to the metafile.

„FormatFile“: the embedded files are extracted to the current working directory.

Set

EmbeddedFilesExtract

String

A JSON array of JSON objects that define which files can be exported. A JSON object looks like this:

- File: File name as given in the pdf

- OutputFilename: Where to save the file

Set

EnablePatternsShadings

(ab CIB pdf toolbox 1.14.0)

String

The property determines if PDF shadings and patterns are rendered as well.

1     PDF shadings and patterns are rendered as well (Default)

0     PDF shadings and patterns are not rendered

Required: CIB renderer

Set

ExtractEmbeddedFile

(from CIB pdf toolbox 1.8.0 onwards)

String

By setting this property you can determine that the CIB pdf toolbox extracts an embedded file during a join run..

Possible values:
- File name as given in the pdf.
- Numbering of the file in the PDF (e.g. „1“ means: The first file in the PDF)

- „zugferd“: Extracting the ZUGFeRD XML (from CIB pdf toolbox 1.9.0 onwards)

The name under which the embedded file is written will be transferred via the OutputFilename property.

"1" = The information of the embedded files is written to the metafile (name, file size, date of creation and last modification) (default).

"0" = No information about embedded files is written to the metafile.

Set

ExtractEmbeddedFileInfo

String

"1" = The information of the embedded files is written to the metafile (name, file size, date of creation and last modification) (default).

"0" = No information about embedded files is written to the metafile.

Set

ExtractXmpMetadata

String

Enables extracting XMP metadata from a PDF file.

The property has JSON syntax.

Example:

{

„1“: „<filenameforfirstpage>“, // extracted xmp from page 1
“2“: „<filenameforSecondpage>“,
“Global“: „<globalXMP>“

}

„<number>“ Unpacks the XMP metadata of a specific page

„Global“ unpacks the global XMP metadata of the PDF document (from the Catalog Dictionary)

„AllPages“ unpacks all pages of XMP metadata.

FieldCaptions.
<utf8prefix>FieldCaptions.
(from CIB pdf toolbox 1.4.82 onwards)

String

dynamic property, labeling of a form field (e.g. FieldCaptions.Radio123)

The value of the property is:

for Pushbuttons: A list of pushbutton labels separated by the “;" symbol. as an ansi-string or as a Utf8-string. (there can be several pushbuttons with the same name, even with different labels)

for radio buttons and checkboxes: a list separated by the “;" symbol indicating the style for each button in the group. The order is the same as for FieldStates (except "Off").

Possible styles are:

„n“ = square

„u“ = diamond

„4“ = check

„8“ = cross

„H“ = star

„l“ = bullet

The button is circular when the caption is the bullet. Otherwise the button is square.

Get

FieldDimensions.

String

dynamic property, coordinates of a form field (e.g. FieldDimensions.Field123)
Format: „page, (x1,x2,y1,y2)“

Get

FieldFlags.

String

dynamic property, attributes of a form field (e.g. (z.B. FieldFlags.Field123)

The content is a list of properties set for the field “Field123). The following attributes are possible:

ReadOnly        read-only, write-protected

Required         required

NoExport         Ignore this field when exporting the form

Multiline          several lines (only for text fields)

Password         protected input (*****) (only for text fields)

NoToggleToOff           Selection cannot be set to empty (radio button)

Radio    redundant, see FieldType.<name>

Pushbutton     redundant, see FieldType.<name>

Combo redundant, see FieldType.<name>

Edit       user defined input allowed (only for combo boxes)

Sort       sort selection (list and combo boxes)

FileSelect         field is selection for file name

MultiSelect      multi selection (only for list boxes)

DoNotSpellCheck        no spell checking

DoNotScroll    no horizontal scrolling (limited text length)

Comb   text in boxes

RadiosInUnison           switch buttons with the same export value on and off simultaneously

CommitOnSelChange   Insert selected value immediately (not only when leaving the field)

RichText Feld contains „rich text“ (no rtf, but text with some html-tags as <b>,<i>)

Get

FieldFont.

String

dynamic property, font type and size of the form field text

Get

FieldNames

String

List of names of form fields in the document, separated by the ";" symbol

Get

FieldOptions.

String

dynamic property, options of a form field (e.g. FieldValue.Field123)

For list and combo boxes, the text entries are separated by the ";" symbol.

Get

FieldOrder.

String

dynamic property, consecutive number of the form field (unsorted)

Get

FieldStates.

String

dynamic property, characteristics of a form field (e.g. FieldValue.Checkbox123)

Get

FieldType.

String

dynamic property, type of a form field (e.g. FieldType.Textfeld123)

Get

FieldValue.

String

dynamic property, for setting or reading form field contents (e.g. FieldValue.Textfeld123)

By setting this property to the PdfMerge module, contents of form fields can be transferred and merged into the PDF. (e.g. FieldValue.Textfield123=Test)

(from version 1.4.84 onwards)

Get/Set

FillTextOutput

(from CIB pdf toolbox 1.27.0. onwards)

String

These options have effect only when the output format option is set as: OutputFormat=FormatText (for plain text output), or OutputFormat=FormatHocr (for HOCR text output).

When option FillTextOutput is set as 0:

            The extracted text is only output         into the output file. If the output             filename is not set within         OutputFilename option then error             should appear.

When option FillTextOutput is set as 1:

            The extracted text is output into the    output file and additionally copied into the output property TextOutput   in Utf8 encoding.

Note:

If FillTextOutput is 1 and OutputFilename is not set then the extracted text is only saved into TextOutput property.

Set

FontsEmbedded

(from CIB pdf toolbox 1.10.0 onwards)

String

If this value is set, all fonts used in the PDF document are embedded in the PDF output document.

Possible values:

„0“       no embedding (default)

„1“       fonts willbe embedded

Note:
In case of PDF/A Conversation, FontsEmbedded will be activated automatically.

Set

FontSubstitution

(from CIB pdf toolbox 1.10.0 onwards)

String

The property is valid if FontsEmbedded=1 or PdfVersion=PDF/Axx.

All fonts not available in the system must be replaced. You can use this property to determine which fonts are used for the replacement.

Syntax:
FontSubstitution ::= <replacement-pairs> “;” <defaultfont>
<replacement-pairs> ::= <pair> | <pair> “;” <replacement-pairs>
<pair> ::= “{” <fontname> “;” <replacementfontname> “}”

In detail:

o   Fonts existing in the target system are embedded without replacement.

o   Fonts that do not exist in the target system are replaced. Is the font in the FontSubstitution property list?

-      Yes:
The replacement font specified there will be embedded.

-      No:
The default replacement font will be embedded.

Example:
FontSubstitution={Helvetica;Arial};
{Zapf Dingbats; Wingdings};Arial

Notes:

o   The CIB pdf toolbox only makes a font substitution if the other font is compatible.

I.e. a symbolic font (e.g. Wingdings) will not be replaced by a nonsymbolic one (e.g. Times New Roman) or vice versa, a CID font will not be replaced by a non-CID one or vice versa.

o   In the case of a font substitution that is not performed but set by property, it ends with return value 352.

o   Due to font-specific properties, e.g. letter width, the layout can be changed in the case of a font substitution. The user must check this for correctness.

Set

FontWorkSpace

String

Path to the directory containing the fonts to be used when rendering the PDF in image format.

It is used by both the internal and Pango rendering engines (see also Property RenderingEngine).

Set

FormfieldNamePrefix

String

Prefix for all form fields of a document, or a list of prefixes separated by the ";" symbol for the documents involved in the Join.

Set

GeneratedDocumentCount

(from Version 1.4.83 onwards)

String

Delivers the amount of generated output documents.

Normally "1" is returned, except for MultiOutput=1 when multiple output PDFs are created.

In case of an error, i.e. abort and no output at all, "0" is returned.

Get

GeneratedPageCount

(from Version 1.8.1 onwards)

String

Delivers the amount of pages printed.

When printing, the number of copies made is counted. When a file is output, the number is identical to that from PageCount.

In case of an error, i.e. abort and no output at all, "0" is returned.

Get

GetFieldInfo

String

This property can be used to query the form fields.

Possible Values:

„1“       The form fields can be be querried

„0“     

„“         No query possible (default)

Get/
Set

GetPageInfo

String

This property can be used to supply the GET property "PageInfo.<page>".

Possible Values:

„1“       This property can be used to supply    the GET property             "PageInfo.<page>"..

„0“
„“         No assignment (default)

Get/
Set

ImageInfo

Get a description about images in a PDF file in JSON format.

Get

ImagePdfCreation

String

Possible Values:

„0“ or empty: Property has no effect.

„1“ CIB pdf toolbox uses CIB renderer to generate content of PDF pages as graphics.

Set

ImagePdfCreationPreserveText

String

If the PdfAFallback case occurs (see Chapter 5.1.4.1.), text contents from the input file can be saved using HOCR Export and transferred to the output file by setting this property.

Possible Values:

„0“: Property has no effect.

„1“: Text contents of the input file are transferred to the output file

Set

IndDCAntiAliasing

String

No longer in use

“2” – Enable x2 anti-aliasing functionality for internal rendering engine

“4” – Enable x4 anti-aliasing functionality for internal rendering engine (see Proprety RenderingEngine);

Default: "0" or empty (no anti-aliasing is carried out)

Set

HiddenPages
(from CIB pdf toolbox 1.8.0)

String

CIB-internal property, currently only supported by CIB image.

A CIB viewer uses this property to specify which pages are to be hidden when displayed by a CIB viewer. This information is stored in the PDF using CIB means.

(Analogous to the hiding of PowerPoint slides in PowerPoint).

Set

IgnoreTemporaryFontFailure

(from CIB pdf toolbox 1.8.0)

String

This property can be used to control the reaction to errors during the temporary installation of fonts from the PDF.

Possible Values:

1         Errors are ignored and processing continues

0         Errors are acknowledged with a return value, e.g. 350, and processing is terminated. (default)

Set/
Get

IncludeInvisibleText
(from CIB pdf toolbox 1.5.114)

String

This property controls whether invisible PDF text (rendering mode = 3) is output by the CIB pdf toolbox or not.

Possible Values:

„1“  Invisible PDF is displayed in the same way as visible PDF text for certain toolbox calls.

„0“  Invisible PDF text is not output with these toolbox calls. (= default)

This property is only effective for subsequent Toolbox calls:

a)     For the toolbox text search with PdfSearchText="...".

b)     When the Pdf file is output in the output formats "FormatText" or "FormatCsv".

c)     When the Pdf file is output in the "FormatXfdf" output format if the "RegionTemplate" property is not empty.

d)     For metafile output for CIB webview (OutputFormat is "FormatWebview").

Set

InputFilename

String

Input file or a list of input files or pairs separated by ";" {x};y from page specification(s)/input file or empty page(s) EMPTY[:width(mm), height(mm)].

InputFilename=

{Odd};Document1.pdf;EMPTY:210,297;

{5,4,1-3};Document2.pdf;EMPTY means that all odd pages of document1.pdf, a blank page of width 210 mm and height 297 mm, the pages 5, 4, 1, 2 and 3 of document2.pdf and a blank page with the width and height of the current last page (page 3 of document2.pdf) are joined in exactly this order.

Syntax:

InputFilename ::= <input file> [";" <input file>]...

InputFilename ::= [<Page Specifications> ";"] (<Filename> | <Memory Blocks> | <Blanks> | <Memory Block Delimiter>)

Page references ::= "{" <page reference> ["," <page reference>]... „}“

Page reference ::= "All" | "Even" | "Odd" | "First" | "Last" | <number> | (<start number> "-" <end number>)

Blank page ::= "EMPTY" [":" <Width_in_mm> "," <Height_in_mm>]

Memory blocks ::= <Memory block> [<Memory block delimiter> <Memory block>]...

Memory block ::= <Address> <Memory block delimiter> <Length>

A <memory block delimiter> is a single character not equal to ";", which if possible does not occur in a file name, e.g. "#", "?".

Address and length are decimal numbers

Get/
Set

InputMemoryAddress

String

Pairs xxx?yyy of memory address/length

Note:
The delimiter is a must and the address must be entered decimal.

Get/
Set

InsertEmptyPageInDuplex

(from CIB pdf toolbox 1.4.83)

String

„0“ = Do not insert duplex blank pages during printing (default)

„1“ = When duplex printing PDF documents with the CIB pdf toolbox, blank pages are automatically inserted between the merged PDF documents if there are an odd number of pages. These separation points are identified by evaluating the stored marks. These marks are set via the property JoinHistory.

(further details, see Property JoinHistory)

Get/
Set

InsertEmptyPageBetweenRtfBookmarks

 (from CIB pdf toolbox 1.4.83)

String

“0” = Do not insert duplex blank pages during printing (default)

„1“ = When duplex printing PDF documents, a blank page is inserted between the places where an RtfBookmark changes or where a join was made (see Property JoinHistory), if the following content would be printed on a back side.

Get/
Set

JoinHistory

(from CIB pdf toolbox 1.4.83)

String

„0“ = The CIB pdf toolbox does not set a marker at the page transitions where it is merged from several individual documents.

„1“ = The toolbox marks this position(s).

Note:

This makes it possible to make a later printout in duplex mode with automatically inserted blank page.

See also Property InsertEmptyPageInDuplex and

InsertEmptyPageBetweenRtfBookmarks

The default value is 1

Get/
Set

StartPage
(from CIB pdf toolbox 1.8.0)

String

This property can be used to store the page number at which the PDF is opened when displayed.

The number is stored in the PDF and evaluated when displayed by Adobe Reader, CIB jView or CIB image.

Set

OpenSize

(from CIB pdf toolbox 1.13.5)

String

Specifies the zoom level in the PDF viewer window when opening the PDF file.

„Standard“       Use default setting of the PDF                         display program (Default)

„Fit“                 Adjust to window height

„FitH“              Fit to window width

Only applies if StartPage is also set.

Set

PartialDocumentAlignment

(from CIB pdf toolbox 1.4.84)

String

„0“ = No insertion of blank pages

„1“ = Each document part is extended by blank pages to an even number of pages.

Only useful for PDF joins without OutputFormat=Printer.

Set

PdfPrintFontCleanupInterval

(from CIB pdf toolbox 1.4.95)

String

Specifies a time interval after which the CIB pdf toolbox removes fonts from the font list. This can prevent fonts from being deleted from the font list too early.

Unit: Hours
Default: 0

With each call the CIB pdf toolbox checks the font list. This contains the fonts that have not yet been cleared with a timestamp. All fonts older than the FontCleanupInterval are removed from the list.

If CibPdfMerge/ CibPdfJoin/CibPdfPrint is called repeatedly in the same process, the font list is only checked if at least 1 hour has passed since the last call.

Set

LicenseKey

String

License key

Set

LicenseCompany

String

Licensee

Set

MaxResolution

(since CIB pdf toolbox 1.5.111)

String

The size of graphics in the metafile can be limited by specifying a maximum resolution (in dpi).

This has an effect on the quality (for example when zooming), but the metafiles become smaller.

Default: Original resolution is kept.

In Acrobat, this feature is available under "Extended/Pdf Optimization" and is called "Bicubic recalculation to ... dpi for images from ... dpi". The CIB pdf toolbox performs the resampling only when saving as metafile, not when saving as PDF. Furthermore, a simpler (non-bicubic) resampling algorithm is used.

Set

ResolutionThreshold

(since CIB pdf toolbox 1.5.111)

String

All bitmaps in the document that have a higher resolution than ResolutionThreshold (in dpi) are scaled down to MaxResolution and then output. This is independent of the resolution of the output medium (bitmap, printer, metafile).

If only MaxResolution is set, then all images with a higher resolution will be downscaled to MaxResolution.

Set

MemoryOutputCallback

String

Address of the callback function for the output document by memory transfer.

For the interface description, see chapter "MemoryOutputCallback".

Get/
Set

MemoryOutputUserdata

String

Userdata of the callback function for the output document by memory transfer.

Get/
Set

MetaFilename

String

Name of the metafile, which is displayed with the CIB viewer.

Set

MultiData

String

„1“= Data file is a multi-control file.

Get/
Set

MultiOutput

String

„1“= Create a separate output file for each data record.

Get/
Set

NeedAppearances

String

„1“= Acrobat rebuilds the form fields when you open them.

Get/
Set

OutputFilename

String

File name of the output document.

Get/
Set

OutputFormat

String

(None): Document is saved via OutputFilename.

“FormatPdf“: Output is a PDF (default)

“FormatView“: A temporary metafile for CIB view is created.

“FormatJavaView“: A temporary metafile for CIB jView is created.

“FormatEmbeddedFile“: Only the files embedded in the document are read and saved. The rest of the document is not processed.

The output format is defined by the property "EmbeddedFileOutputFormat".

“FormatPrinter“: Document is output to the printer.

„FormatText“: The output format is plain text (as Unicode).

(since CIB pdf toolbox 1.4.81)

Also for this output format the memory interface is supported from CIB pdf toolbox 1.4.87 on.

If the contents of form fields are to be transferred to the text output, the property FlattenFormfields=1 must be set.
„FormatXfdf“: The PdfJoin module exports the form data from the PDF as a Xfdf file. This file contains the field names and field contents in XML format.

(since CIB pdf toolbox 1.4.90)

„FormatXfdfWithAnnots“: The PdfJoin module exports the form data from the PDF as a Xfdf file as well as additional comments and their graphic appearance.

The following types are supported:
text | caret | freetext | fileattachment | highlight | ink | line | circle |square | polygon | polyline | sound | squiggly | stamp | strikeout | underline

(since CIB pdf toolbox 1.4.105)

„FormatSearchablePdf“: Text contained in graphics is extracted as text.

(since CIB pdf toolbox Version 1.6.116)

„FormatBarcodeXml“: The barcode information read from the PDF via the "BarcodeInfo" property is output in XML format.

(since CIB pdf toolbox 1.8.0)

„FormatBarcodeCsv“: The barcode information read from the PDF via the "BarcodeInfo" property is output in CSV format.

(since CIB pdf toolbox 1.8.0)

„FormatInfo“: Global document properties are read from the PDF using PDF join.

(since CIB pdf toolbox 1.6.116f)

“FormatPrinterCups”:  Print control via CUPS. Only available for Linux/Unix. (see chapter 14.1.2 "Printing via CUPS" )

„FormatTiff“: Creates a graphic file in Tiff format.
(since CIB pdf toolbox Version 1.4.102)

„FormatPng“: Creates graphic file in PNG format.

(since CIB pdf toolbox Version 1.4.102)

„FormatJpeg“: Creates graphic file in Jpeg format.

(since CIB pdf toolbox Version 1.4.102)

„FormatWebview“: Output format for display in CIB doXiview.
(since CIB pdf toolbox Version 1.4.102)

“FormatWebP“: Creates graphic file in WebP format (uses lossy and non lossy compression).

(since CIB pdf toolbox Version 1.9.0)

„FormatJpegXR“: Creates a graphic file in JPEG extended range format.
(since CIB pdf toolbox Version 1.9.0)

„FormatBmp“: Creates a graphic file in BMP format.

(since CIB pdf toolbox Version 1.8.5a)

„FormatBmpLz4“: Generates graphic file in BMP format, where data is compressed according to lz4 standard.
(since CIB pdf toolbox Version 1.8.5a)

„FormatImage“: During a rendering process several output graphic formats are generated. These must be raster graphics formats.
(since CIB pdf toolbox Version 1.14.0)

„FormatSvg“: Output of a graphic file in SVG format (Scalable Vector Graphics).
(since CIB pdf toolbox Version 1.14.0)

”FormatAnalyse”: The verification process for verifying the signature is always performed completely and the SignedDocument.xxx properties are set for the signature. This allows you to track which processing steps were successful and which were not.

(since CIB pdf toolbox Version 1.6.115)

“FormatExtractImages”: If this output format is specified, all Image-XObjects contained in the input PDFs are exported. The output is in TIFF format or (for certain Pdf image objects) in JPEG format under the file name specified in OutputFilename.

(since CIB pdf toolbox Version 1.4.113)

„FormatCsv“: Text extracted from the PDF is output as CSV file.
(since CIB pdf toolbox Version 1.4.95)

Get/
Set

OutputRtfBookmarkNames

If the OutputRtfBookmarkNames=1 option and PageSelection option is set using CIB bookmark, then the output image names contain bookmark names:

The format is  OutputRtfBookmarkNames=0:

<OutputFilename> - <PageNumber>

example: out-000001.png

The format is OutputRtfBookmarkNames=1(extended output):

<OutputFilename> - <RtfBookmarkName> - <CopyNumber> - <PageNumber> - <PageNumber>….

example: out-AUF1-0000-0000-00001.png

PageCount

String

Number of pages in the document, decimal number as string.

Get

PageFieldNames.<page>

String

Returns the form fields of each page.

For example, PageFieldNames.0 contains the form fields of the first page.

Get

PageInfo.<page>

String

Dynamic property in which information about a page is returned (width, height and rotation).

(Property GetPageInfo must be set)

E.g. PageInfo.1 contains the information about the second page

Get

PdfDocPropertyEncoding
(since CIB pdf toolbox 1.4.78)

String

“” = no Encoding (default)

“Base64” = Base64 Encoding

Get/
Set

PdfDocProperties
(since CIB pdf toolbox 1.4.78)

String

Returns the names, separated by ";", of all user-defined document properties.

Get

PdfDocProperties
(since CIB pdf toolbox 1.4.78)

String

Set new or modify custom document properties.

Set

PdfDocProperty.<name>

(since CIB pdf toolbox 1.4.78)

String

Dynamic property, reading or setting the value of the user-defined document property whose names are supplied via the “PdfDocProperties” property. The value is encoded according to the "PdfDocPropertyEncoding" property. Attention: new document properties must be made known in advance via the "PdfDocProperties" property. If unknown document properties are specified, the CIB pdf toolbox returns Error code 99.

Get/
Set

PdfLinearized

String

Control whether the output PDF is optimized for fast display on the web.

Possible values:

"0" no optimization (default).

"1" Optimization is performed.

Get/
Set

PdfSearchIgnoreCase

String

Control whether the search in the PDF is case sensitive.

Possible values:

"0" not case-sensitive (default)

"1" case-sensitive search

Set

PdfSearchFont

String

Set a specific font. A subsequent text search will only return texts that appear in the document with this font.

Example:

PdfSearchFont="CourierNewPS-ItalicMT" means that only text passages in the document that use this font will be searched for.

Caution:

The font name must match the font name in Acrobat Reader's document properties.

Set

PdfSearchResult

String

Returns the location of the string in the document. Each found location is described by a sequence of rectangles. These rectangles indicate the exact position of the searched string in the page text.

A rectangle is indicated by:

<page>,<left>,<top>,<right>,<bottom>.

If a found location extends over several lines, a sequence of rectangles separated by semicolons is returned.

Examples:

PdfSearchResult=

"1,500,100,600,110;1,50,111,100,121" means that the search text on page 1 extends over two lines. Once from (500,100) to (600,110) and from (50,111) to (100,121).

If the search text occurs more than once in the document, the different places where it is found (indicated by {}) are listed next to each other.

"{1,500,100,600,110;1,50,111,100,121};{2,500,100,600,110;2,50,111,100,121}" means that the search text also appears on page 2 from (500,100) to (600,110) and from (50,111) to (100,121).

A finding place can also extend over several pages.

A result like:

"1,500,750,600,760;2,50,50,100,60"

means that the reference on page 1 goes from (500,750) to (600,760) and continues on page 2 from (50,50) to (100,60).

Get

PdfSearchResultContext

(since CIB pdf toolbox 1.4.80)

String*

Returns the location of the string in the document with its context.

Character string as described in “PdfSearchText” and context as described in “PdfSearchContext”.

The search result is structured as follows:

={<Find1>};{<Find2>};...

<Location> = {<Context>};<Rectangle1>;<Rectangle2>;...

<Rectangle>= see PdfSearchResult

<Context> = <Before Context> <Search Chain> <After Context>

If there are not enough characters in the document to fill the defined pre- or post-context (e.g. at the beginning or end of a document), spaces are filled in.

Example:

Search string=children, pre-context=3, post-context=5 returns the result:

{{children to};2,214,967,246,836,243,862,256,086}{{{children not};2,202,192,336,836,231,087,346,086}

The PdfSearchResult property continues to be additionally assigned.

Get

PdfSearchText

String

Set the searched string in the document. This can also be a longer text passage.

Set

PdfSearchContext

(since CIB pdf toolbox 1.4.80)

String

Set a context for the searched string, which is output as a search result.

="m;n"

m= Number of characters before

n= number of characters after the searched string

If only a number is specified, the characters after the search string are used.

Set

PdfVersionInfo

(ab CIB pdf toolbox 1.18.0)

String

This property returns the PDF version and special version of the document.

The output is in JSON format.

example:

{"Version": "1.4", "SpecialVersions":["PDF/A", "PDF/X"]}