CIB pdf toolbox technical guide (EN)

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"]}

The PDF document has PDF version 1.4 and it also meets the PDF/X and PDF/A specifications.

Get

FirstPage

LastPage
(since CIB pdf toolbox 1.4.81)

String

Restrict the text search (PdfSearchText) or the text output (OutputFormat=FormatText) to one page area.

Example:

FirstPage=1 LastPage=3

Only pages 1 to 3 are edited.

If the LastPage specification is missing, the range goes to the end of the document.

Set

PdfSecurityMethod

String

Possible values:

„“ = no security method

„Standard“ = method is „adobe standard security“

Get

PngCompressLevel

(ab CIB pdf toolbox 1.4.105)

String

Control for the degree of compression of the graphic when saving.

The writing speed can be increased by decreasing the compression (and thus increasing the file size). For example, if the file size is doubled, the file is written five times faster.

Possible values:

1 Default value for PNG compression

0 No compression

9 Maximum compression

2 Default

Set

PrefixDelimiter”

(ab CIB pdf toolbox 1.3.62)

String

The parameter - prefix delimiter defines a separator between alias and variable name and switches the prefix mechanism on permanently.

By setting the parameter -prefix-delimiter, the variables are kept unique when using multi-node systems.

(identical to CIB merge-prefix-delimiter)

Default=empty

Set

PrintCentered

String

If the property is set to "1", the page (in x and y direction) is centered with respect to the printable area (not the paper). (default)

If this property is set to "0", no centering takes place.

Get/
Set

PrintScaling

String

Scaling options of the pages to the print area:

PrintScaleNone - The PDF page is not scaled to printer limits. This means that texts and graphics are cut off if they are outside the print page size. The upper left corner of the PDF page corresponds to the upper left corner of the printable area - not the paper. If the PDF page is not in the same page format as the paper, the upper left corner of the PDF page refers to the rotated print page.(default)

PrintScaleDown - larger paper is scaled down to the printable area

PrintScaleFit - the paper is scaled to fit the printable area, i.e. larger paper is reduced and smaller paper is enlarged

Get/
Set

Progress

String

Returning a JSON-description of current progress of the current running JOB. This property can be retrieved from a different thread as the thread in which the current execute is running.

The JSON description consists of the Keys

“AmountSteps” and “CurrentStep”. AmountSteps defines, how many internal bigger steps are done and the CurrentStep defines how many Steps were already done.

Get

RegenerateXMP

(since CIB pdf toolbox Version 1.6.116f)

String

"0": Nothing will be done. (default)

„1“: Updates XMP data in the PDF from the “DocInfo” values.

Set

RenderingEngine

(since CIB pdf toolbox Version 1.7.0)

(ab CIB pdf toolbox Version 1.14.0)

String

"Internal" - Internal rendering engine is used (default for Unix systems).

"WinGDI" - Windows rendering engine is used (default for Windows systems).

"CIBRenderer" - Pango-Cairo rendering engine is used.(Default für Unix- und Windows-Systeme)

Set

TraceFilename

String

Specifies where the Toolbox log messages are output to.

Get/
Set

RegionTemplate

String

The property is used to pass the name of the XFDF file that contains the areas (rectangles) from which text is to be extracted. The extracted text is written to an XFDF or CSV file.

Prerequisite:

OutputFormat=FormatXfdfWithAnnots

RegionTemplate=<name>.xfdf

Set

RegionThreshold

String

The property specifies the percentage of a character that belongs to the region. If a character extends into the region at a lower percentage than specified here, it does not belong to the region.

RegionThreshold=<integer>

Condition:

OutputFormat=FormatXfdfWithAnnots

and use of RegionTemplate

Set

SvgImageBounds

(since CIB pdf toolbox Version 1.20.0)

String

This property can be used to limit the maximum resolution (and thus the size of the output of the rendering process) for SVG graphics.

Possible value:

A JSON string with the following parameters/values:

{

"MinImageHeight": 50,

// The minimum height of the input graph at which this algorithm takes effect,

default: 50

"MinImageWidth": 50,

// The minimum width of the input graphic at which this algorithm takes effect,

default: 50

"ResolutionThresholdJpeg": 180,

// Threshold value above which the size of the JPEG graphic is reduced. The size is reduced to the value from "MaxResolutionJpeg" (here: 150 DPI).

"ResolutionThresholdPng": 180,

// Threshold value above which the size of the PNG graphic is reduced. The size is reduced to the value from "MaxResolutionPng" (here: 150 DPI).

"MaxResolutionJpeg": 150,

// If the threshold value from ResolutionThresholdJpeg is exceeded, the JPEG graphic is downscaled to 150 DPI.

"MaxResolutionPng": 150,

// If the threshold value from ResolutionThresholdPng is exceeded, the PNG graphic is downscaled to 150 DPI.

}

Set

TempPath

(since CIB pdf toolbox Version 1.20.0)

String

The path specified in this property is used to store:

- temporary font files

- the list of installed fonts

- temporary Postscript pages (for Prostscript printing)

Other paths, such as to the output file directory, are not affected by this property.

The path must point to a valid directory. It can be a relative or absolute path.

Set

GraphicLayerInfo

(ab CIB pdf toolbox Version 1.25.0)

String

This property reports which graphics are found in the PDF during the rendering process.

The output is in JSON format

Required:

OutputFormat=FormatText | FormatWebview | FormatJavaView

RenderingEngine=CIBRenderer.

The output depends on the content of the PageSelection property:   PageSelection empty:          GraphicLayerInfo contains the information for the whole PDF.

PageSelection set:

            GraphicLayerInfo contains the information for each selected page.

Example:

PageSelection empty:

{"stats": {"inlineImageCount":9,"externalImageCount":3,"externalImageIdents":[10,15,20]}}

PageSelection set to “1-2”:

{"stats": [ {"inlineImageCount":0,"externalImageCount":1,"externalImageIdents":[10]},  {"inlineImageCount":3,"externalImageCount":2,"externalImageIdents":[15,20]}]}

Get

TextLayerInfo

(since CIB pdf toolbox Version 1.18.0)

String

This property reports which text groups are found in the PDF during the rendering process.

The output is in JSON format

The following text groups are possible:

any_visible – Any visible text

simple_invisible – Invisible text, not specially marked

cibocr_invisible – Invisible text, marked by the CIB pdf toolbox as CIB_HOCR

others_invisible – Invisible text, marked by other PDF processors

Example:

{”groups”: [”any_visible”, “simple_invisible”, “cibocr_invisible”, “others_invisible”]}

Note:

      OutputFormat must be on FormatText, FormatWebview or FormatJavaView or must be set RenderingEngine=CIBRenderer for graphic formats.

      The PageSelection property influences the output format of the TextLayerInfo property.

No PageSelection set: TextLayerInfo contains the composite information about the whole document.

PageSelection is set:
TextLayerInfo contains the information individually per selected page.

Examples:

No PageSelection set:
{”groups”: [”any_visible”, “simple_invisible”, “cibocr_invisible”, “others_invisible”]}

PageSelection is set to 1-3,

Page 1 contains only visible text,

Page 2 contains visible and simple invisible text

Page 3 contains no text at all:
{“groups“: [[“any_visible“],[“any_visible“,“simple_invisible“],[]]}

Get

TextMark

(since CIB pdf toolbox Version 1.37.0)

String

The property works only for output format FormatText and works in conjunction with TextSelectionFilter.

If the value of TextSelectionFilter is set as: TextSelectionFilter={"groups":["marked_invisible"]}

Then CIB pdf toolbox outputs only invisible text which is marked with special tag, specified by TextMark property.

For other groups in TextSelection filter the property TextMark is ignored

CIB pdf toolbox extracts text, which is marked in pdf content stream with special tag: CIB_HOCRerty. TextMark is ignored.

Example:

CibRsh.exe OutputFormat=FormatText  TextSelectionFilter=

{"groups":["marked_invisible"]}

TextMark=CIB_HOCR -fj input.pdf output.txt

Get

TextOutput

(since CIB pdf toolbox version 1.37.0)

String

If we set FillTextOutput=1 then the output property TextOutput is filled by text in Utf8 encoding.

Get

TextSelectionFilter

(since CIB pdf toolbox Version 1.18.0)

String

The property IncludeInvisibleText can be configured via TextSelectionFilter, i.e. it controls in detail which types of visible and invisible texts are output.

It has JSON format and, if set, overrides the specifications from IncludeInvisibleText.

In addition to the simple text groups any_visible, simple_invisible, cibocr_invisible, others_invisible (for details see TextLayerInfo property), composite text groups can also be used:

 any_invisible – any invisible text (simple_invisible + cibocr_invisible + others_invisible)

any – all text (any_visible + any_invisible)

Notes:

The property only affects output to text and metafiles.

It is only valid for OutputFormat

FormatText, FormatWebview, FormatJavaView, FormatView.

Examples:

TextSelectionFilter={“groups“:[“cibocr_invisible“]}
Only texts of text group “cibocr_invisible” are output (if available).

TextSelectionFilter={”groups”:[”any_visible”, “any_invisible”]}
All text groups are output.

Set

UseColorProfileForCMYK

(since CIB pdf toolbox Version 1.4.98)

String

Possible values for conversion to RGB:

"1" "US Web coated" and "sRGB" profiles are used (default).

"0" simple variant.

Set

UseJbig2Compression

(ab CIB pdf toolbox Version 1.10.0)

String

Attention: For graphic overlay only.

This property can be used to deactivate the Jbig2 compression, which is activated by default for overlay graphics.

0            Jbig2 compression is disabled, standard ZLIB compression is applied. 

1            Jbig2 compression is activated (default).

Note:
Jbig2 compression is not used for:
1) JPG graphics.
2) Graphics with more than 2 colors.

Set

UseWinGDI

String

No longer in use,

replaced by RenderingEngine=WinGDI

„1“ = Windows rendering engine is used (default for Windows systems)

„0“ = Internal rendering engine is used (default for Unix systems)

Set

UseSvgExternalImages

(since CIB pdf toolbox Version 1.17.0)

Allows all internal images that are combined to SVG graphics to be stored separately from the SVG content as external resources (JPEG or PNG).

Possible values:

0          deactivated

1          activated

ViewCallback

String

Adresse des Callbacks für Rückmeldung nach jeder Seite (interne Prop.)

Get/
Set

WorkSpace

(since CIB pdf toolbox Version 1.4.81):

(since CIB pdf toolbox Version 1.4.84):

String

Defines the working directory for all file name specifications, except output files.

The path is specified as a zero-terminated character string. The path can be absolute or relative to the working directory of the calling process.

All file specifications (without absolute path) in properties are considered relative to this workspace.

A list of work¬directories can also be specified. The individual specifications are separated by semi-colons. For each file used, a search is started and the first location is used.

From this version on, the WorkSpace property no longer applies to output files.

Get/
Set

PageXmpMetadata

(since CIB pdf toolbox Version 1.14.0):

String

This property is used to add or overwrite page-related metadata in a PDF. They are referenced on the respective page via "/Metadata".

Syntax:
The syntax for the page specification is identical to that of property "InputFilename", only "empty page" is not required here.

Metadata (UTF-8 encoded) can be specified for each page or page range of the output PDF. The metadata can be transferred as an XML file or memory block.

If a page already contains metadata, it is replaced by the new data. If only some pages of a document are addressed, metadata of the remaining pages remains unchanged.

Examples:

PageXmpMetadata=
“{First};metadata1.xml;{2};metadata2.xml“

PageXmpMetadata=
“{All};#;276534#1000“

PageXmpMetadata=
“{3};#;276534#1000;{2};metadata2.xml“

Set

XMPMetadataExtension

String

Allows the specification of one or more XMP snippets of type rdf:Description. These will be added to the metainfo of the resulting PDF during the conversion process (CibPdfSave()).

Please note the official XMP specification from Adobe.

Set

XfdfIgnorePageRotation

(since CIB pdf toolbox Version 1.17.0):

String

0 (default): Coordinates are interpreted in the page coordinate system and depend on page orientation and cropping. (0,0) is the origin of the MediaBox of the page.

1: Coordinates are interpreted relative to the visible side. (0,0) is the coordinate bottom left on the visible side (crop and rotate)

Set

XfdfFlipPositionY

(since CIB pdf toolbox Version 1.24.0):

String

This property is used to change the starting point / anchor of the coordinates from bottom left to top left.

0 (default): Starting point / anchor of the coordinates on the lower left.

1: Starting point / anchor of the coordinates top left.

Set