DocInfo.Author

String

Enters the author.

Overwrites the information stored in the PDF.

Get/
Set

DocInfo.Title

String

Enters the title.

Overwrites the information stored in the PDF.

Get/
Set

DocInfo.Subject

String

Enters the subject.

Overwrites the information stored in the PDF.

Get/
Set

DocInfo.Keywords

String

Enters the keywords.

Overwrites the information stored in the PDF.

Maximum length is 64K.

Get/
Set

DocInfo.CreationDate

String

Enters the creation date

Format:

JJJJMMTThhmmss+01‘00‘

Get/
Set

DocInfo.ModDate

String

Enters the date of change

Format:

JJJJMMTThhmmss+01‘00‘

Get/
Set

ModuleName

String

Enters the program with which the PDF was created.

Get/
Set

CallerApplicationname

String

Application that changed the PDF.

Get/
Set

OutputFormat

Format of the output file

The following graphic formats are supported:

FormatTiff
FormatPng,
FormatJpeg

FormatBmp
(since CIB pdf toolbox Version 1.8.5a)

FormatWebview

String

OutputFormat

(since Version 1.5.113)

FormatExtractImages

If this output format is specified, all Image-XObjects contained in the input PDFs are exported. The output is in TIFF format or in JPEG format under the file name specified in OutputFilename.

Note:

-         No PDF is written

-         OutputFilename is a required field

-         Output to memory is not possible

-         No dpi value is written to the TIFF image file(s)

A.) For the TIFF images there are two cases to distinguish:

1.) TiffSinglePage=“0“ (default):
All Pdf image objects that are not exported as JPEG images are written to a TIFF file. The name of the TIFF file is the one from OutputFilename, with extension ".tif“.

2.) TiffSinglePage=“1“:
Each Pdf image object that is not exported as a JPEG image is saved as a separate TIFF file. The names of these TIFF files have the structure
“Output-000pp-000oo.tif“        whereas

„Output“ is the value of OutputFilename, but without extension

„000pp“ is the number of the page on which the image object first appears.

„000oo“ is the number of the image object.

TIFF images can be generated directly or the Pdf image objects are first converted into the DIB format (Windows Bitmap) and from there into the TIFF format.
The TIFF image is generated directly if the following applies to the Pdf image object:

- The Pdf image object has none of the filters JBIG2Decode, DCTDecode or JPXDecode.

- It has no mask and is not a mask.

- The color space is "DeviceGray", "DeviceRGB" or "DeviceCMYK" (with BitsPerComponent 8).

- The entry "Decode" is missing or is the default entry for the respective color space ([0 1] for "DeviceGray", [0 1 0 1 0 1] for "DeviceRGB", [0 1 0 1 0 1 0 1] for "DeviceCMYK").

For all other Pdf image objects the TIFF output is done via the intermediate step as DIB format. In this case, not all image properties are retained.

Remained also with the DIB intermediate step:

Number of pixels in width and height of the image object.

The following can be changed at the DIB intermediate step:
Colorspace, BitsPerComponent and ComponentsPerPixel

B.) JPEG images are created directly (without conversion) for Pdf image objects that meet the following conditions and are always saved as individual JPEG images:
- The Pdf image object has a filter "DCTDecode“.

- It has no mask and is not a mask.

- The color space is "DeviceRGB“.
- The entry "/Decode" is missing or [0 1 0 1 0 1].

The JPEG file name is formed according to the same rule as the file name for the individual TIFF files (see above).

String

ExtractImagesCallback

(since Version 1.17.0)

Address of the callback function called by the CIB pdf toolbox when parsing the PDF document each time an image object is extracted.

String

ExtractImagesUserdata

(since Version 1.17.0)

Address of the memory area where the extracted image data and its hash value is passed.

String

OutputFormat

(since Version 1.14.0)

FormatImage

With this output format, the CIB pdf toolbox generates several output graphic formats during one rendering process.  These must be raster graphics formats.

Required:

RenderingEngine="CIBRenderer"

The "ImageType" property defines which graphic formats are to be created.

String

OutputFormat

(since Version 1.14.0)

FormatSvg

The CIB pdf toolbox outputs a graphic file in SVG format (Scalable Vector Graphics).

This is the specification recommended by the World Wide Web Consortium (W3C) for the description of two-dimensional vector graphics, which is based on XML.

Name of the generated output:
Outputfilename.svg

Required:

RenderingEngine=“CIBRenderer“

String

OutputFilename

Name of the output file, with the appropriate extension.

PNG and JPEG: One file is output per page in the PDF. The name is made unique by appending a consecutive number.

String

InputFilename

Name of the input PDF

Several PDFs, separated by semicolon, can also be entered.

String

AbortDocCallback

(since Version 1.10.0)

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

Interface description see chapter "AbortDocCallback”

String

AbortDocCallbackPointer

(since Version 1.10.0)

Benutzerdaten des Callbacks für Rückmeldung nach jeder Seite

String

EventNotifier

(since Version 1.24.0)

The pointer to the instance of the callback class CibPdfEventNotifier is assigned to this property.

This enables the output of RGB565 data into memory.

Required for this functionality is OutputFormat=FormatBmp and RenderingEngine=CIBRenderer

String

ImageAlign

(since version 1.8.6c)

The property can be used to improve the alignment of graphics in the PDF if the graphics are contiguous and not rotated.

Condition:
RenderingEngine=CIBRenderer

0          Optimization is switched off

1          Optimization is switched on    (default)

String

ImageScaling

(since version 1.9.7)

(since version 1.14.0)

The property can be used to specify the maximum size of the graphic.

width;height in px, or resolution in dpi.

Valid values:
[<width>px];[<height>px] | <resolution>[dpi]

Note:
ImageScaling includes the functionality of TiffResolution. If both properties are set, only ImageScaling is evaluated.
In the case of the resolution, only the specification of a value is required, since only one identical resolution is supported for both axes.

Examples:

ImageScaling=100px;200px
Maximum height 200 px or maximum width 100 px, depending on which limit applies.

ImageScaling=;200px
Fixed height 200px, any width

ImageScaling=200px
Fixed width 200px, any height

ImageScaling=100dpi oder ImageScaling=100
Resolution 100 DPI is used.

Extension for the use of the property "ImageType":

When generating several graphic formats in one rendering process, graphic proportions can be specified here for each graphic format generated. The values are listed in the same order as the graphic formats were defined in the "ImageType" property. For better readability the value pairs can be grouped with curly brackets.

It is possible to enter blank values ";;", then the default DPI setting takes effect.

Examples:

ImageType=“png;tiff;bmp“
ImageScaling=“{50px;50px};{1000px;1000px};{500px;500px}“

ImageType=“jpg;bmp“
ImageScaling=“50px;50px;;“
The JPG has 50x50 px, the BMP the default DPI setting.

String

ImageType

(since version 1.14.0)

This property can be used to specify which graphic formats the CIB pdf toolbox should generate in a rendering process. Currently only raster image formats are possible here.

Required is OutputFormat= FormatImage and RenderingEngine="CIBRenderer".

Possible values are:
jpg, jpeg, webp, bmp, bmplz4, jpegxr, png, tiff, tif

Example:
ImageType=“png;tiff;bmp;webp“

Name of the generated graphic files:

In order to achieve unique file names for the various output formats of a graphic file, the CIB pdf toolbox creates the file name as follows:
<OutputFilename>-image<PageNumber>-copy<NumberOfCopies>.<FileExtension>

Example:

OutputFormat=“FormatImage“
ImageType=“png;png;tiff“
ImageScaling=“{50px;50px};{500px;500px};{300px;300px}“
OutputFilename=“out.bmp“
2 pages

Results in the following files:
out-image00001-copy00001.png
out-image00001-copy00002.png
out-image00001-copy00003.tiff
out-image00002-copy00001.png
out-image00002-copy00002.png
out-image00002-copy00003.tiff

Note:
The file extension of OutputFilename is ignored, i.e. a file "out.bmp" is not created, but only the file types defined in ImageType.

String

Threads

(since version 1.15.0)

With this property, the conversion into several graphic formats and the subsequent writing of the files can be parallelized during the rendering process, which leads to a better performance.

Required are the properties ImageType and RenderingEngine=“CIBRenderer“

Possible values:

N     A maximum of N threads are used to create the graphic files.

0      No use of threads (default, behaviour of previous versions)

String

TiffResolution

Resolution of the graphic output.

Default value: 150 DPI

String

TiffStripSize

StripSize as multiple of 8kB.

0 for none,

Default is 4, so 32kB strips

String

TiffJpegQuality

Only with TIFF:

Jpeg compression factor, default is 75%

String

TiffSinglePage

Only with TIFF:

One TIFF file can be generated per PDF page.

0          One TIFF file per PDF (default)

1          One TIFF file per PDF page

String

TiffColorDepth

Options for the color depth

Only with JPG and PNG:

2Colors

256Colors

256Grayscale

TrueColor (24Bit, Default)

Only with BMP:
(since CIB pdf toolbox Version 1.24.0)

HighColor
Output of rendered PDF pages as 16bpp BMP to disk or as RGB565 bitmaps to memory.

(Requires RenderingEngine=CIBRenderer)

String

WebviewOutputConfiguration

(since CIB pdf toolbox Version 1.10.0)

(since CIB pdf toolbox Version 1.17.0)

This property can be used to configure the generated output for the CIB doxiView so that only one output format is used instead of Png and Metafile by default.

Possible Values:

„Image“:         
if this value is set, one Png image per input document page is generated for the CIB doxiView.

„Metafile“:      
with set value a metafile for the CIB doxiView is generated per input document page

 „MetafileAsSingleFile“:
if this value is set, no separate metafiles are written per page, all information is written into one metafile.

„MetafileNoPageContent“:     
switches off the processing of page content streams. As a result, page content-related meta records such as TEXTRECT are not output. The metarecords STARTPAGE, ENDPAGE, and EMBEDDEDFILE2 are not affected..

„MetafileNoOutlines“: 
Switches off the processing of outlines in the PDF document, as a result no outline meta-records are output.

the values „MetafileNoOutlines“, MetafileNoPageContent“ and „MetafileAsSingleFile“ may be used cumulatively. They are only valid if "WebviewOutputConfiguration" is set to create metafiles only. When creating images, the entire PDF document must always be processed.

Examples:

Standardvalue = „Image;Metafile“

(Since CIB pdf toolbox 1.20):

Additionally, the option "ImageSkipAnnotations" can be used to specify that certain types of annotations for CIB doXiview rendering are not rendered into the output images.

The option "ImageSkipAnnotations" has no effect on the output to a metafile.

Example:

WebviewOutputConfiguration=“Image;ImageSkipAnnotations:[Redact,Line];Metafile“

The following values are possible for annotation types: “Text”, “Link”, “FreeText”, “Line”, “Square”, “Circle”, “Polygon”, “PolyLine”, “Highlight”, “Underline”, “Squiggly”, “StrikeOut”, “Stamp”, “Caret”, “Ink”, “Popup”, “FileAttachment”, “Sound”, “Movie”, “Widget”, “Screen”, “PrinterMark”, “TrapNet”, “Watermark”, “3D”, “Redact”.

“MetafileWithGlyph” :
If set, a new metafile record TEXTRECT2 is written in the CIB doXiview Metafile, which writes widths for the individual characters in addition to the text information.

String

SkipFormfieldContent

(since CIB pdf toolbox Version 1.16.0)

Enables you to hide the contents of form elements (text fields, checkboxes, list fields) during display.

Possible Values:

0: Form contents are displayed

1: Form contents are not displayed

To be used in conjunction with OutputFormat=FormatWebview

ZUGFeRDXml

Specifies a ZUGFeRD-compatible XML file, which is then embedded in the PDF in a ZUGFeRD-compatible manner.

If OutputFormat=FormatInfo is specified, the property ZUGFeRDXml is assigned the name of the Zugferd XML if one is already embedded in the input PDF.

String

ZUGFeRDSchema

Specifies a schema file against which the ZUGFeRD XML file can be checked during import or extraction.

Example: Invoice.xsd

String

ZUGFeRDDoCheck

Specifies whether a schema check should be performed when extracting or importing a ZUGFeRD XML file

Possible Values:
0          no scheme check (default)
1          Scheme check is performed

If no scheme file is specified in property ZUGFeRDSchema, the scheme file contained in the ZUGFeRD XML file is used for the scheme check. If the scheme check fails, an error 355 is issued.

String

ZUGFeRDDescription

A description of the ZUGFeRD XML file can be stored in this property. This description is included in the PDF when the XML file is embedded.

Input: Any text

String

Name

Value

Effect

ApplyRedactAnnotations

= 0  (default)

= 1 Blackening is carried out

If a property is set, the CIB pdf toolbox blacks out the areas specified in the annotations.

Redaction (blackening) occurs in the following steps:

1.      XFDF file is created with the editorial annotations.

2.     CIB pdf toolbox imports these annotations into the PDF document via "AnnotationsFilename=abc.xfdf".

The result is then a PDF that contains the areas to be blackened.

Example for XFDF file

<?xml version="1.0" encoding="utf-8"?>

<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve">

<annots>

<redact

page="0"

rect="66.0,474.0,152.0,393.0"

interior-color="#000000">

</annots>

</xfdf>

Note:

-> The page numbers are zerobased specified.

-> The desired coordinates can be set by specifying a rectangle

rect="66.0,474.0,152.0,393.0" -> where PDF coordinates are used as the unit (1 cm corresponds to 28.333... PDF coordinates). The rectangle is given as x,y lower left corner and x,y upper right corner. The origin (coordinate 0,0) of the page is at the bottom left.