CIB pdf toolbox technischer Leitfaden (DE)

DocInfo.Author

String

Eingabe des Verfassers.

Überschreibt die im PDF hinterlegte Information.

Get/
Set

DocInfo.Title

String

Eingabe des Titels.

Überschreibt die im PDF hinterlegte Information.

Get/
Set

DocInfo.Subject

String

Eingabe des Betreffs/Themas.

Überschreibt die im PDF hinterlegte Information.

Get/
Set

DocInfo.Keywords

String

Eingabe der Stichwörter.

Überschreibt die im PDF hinterlegte Information.
Maximale Länge beträgt 64K.

Get/
Set

DocInfo.CreationDate

String

Eingabe des Erstellungs-Datums

Format:

JJJJMMTThhmmss+01‘00‘

Get/
Set

DocInfo.ModDate

String

Eingabe des Änderungs-Datums

Format:

JJJJMMTThhmmss+01‘00‘

Get/
Set

ModuleName

String

Eingabe des Programms, mit dem das PDF erstellt wurde.

Get/
Set

CallerApplicationname

String

Anwendung, die das PDF geändert hat.

Get/
Set

OutputFormat

Format der Ausgabedatei

Unterstützt werden die Grafikformate:

FormatTiff
FormatPng,
FormatJpeg

FormatBmp
(ab CIB pdf toolbox Version 1.8.5a)

FormatWebview

String

OutputFormat

(ab Version 1.5.113)

FormatExtractImages

Bei Angabe dieses Ausgabeformats werden alle Image-XObjects, die sich in den Eingabe-PDFs befinden, exportiert. Die Ausgabe erfolgt im TIFF-Format oder im JPEG-Format unter der bei OutputFilename angegebenen Dateibezeichnung.

Achtung:

-           Es wird kein PDF geschrieben

-           OutputFilename ist ein Mussfeld

-           Eine Ausgabe in den Speicher ist nicht möglich

-           Es wird kein dpi Wert in die TIFF-Bilddatei(en) geschrieben

A.) Für die TIFF-Bilder gibt zwei Fälle zu unterscheiden:

1.) TiffSinglePage=“0“ (default):
Alle Pdf Bildobjekte, die nicht als JPEG Bild exportiert werden, werden in eine TIFF-Datei geschrieben. Deren Name ist der aus OutputFilename, mit Endung “.tif“.

2.) TiffSinglePage=“1“:
Jedes Pdf Bildobjekt, das nicht als JPEG Bild exportiet wird, wird als eigene TIFF-Datei gespeichert. Die Namen dieser TIFF-Dateien haben den Aufbau
“Output-000pp-000oo.tif“        wobei

„Output“ ist der Wert von OutputFilename, aber ohne Endung

„000pp“ ist die Nummer der Seite, auf der das Bildobjekt das erste Mal auftritt.

„000oo“ ist die Nummer des Bildobjekts.

Die Erzeugung der TIFF-Bilder kann direkt erfolgen oder die Pdf Bildobjekte werden zuerst in das DIB-Format (Windows Bitmap) und von dort in das TIFF-Format konvertiert.
Die Erzeugung des TIFF-Bildes erfolgt direkt, wenn für das Pdf Bildobjekt folgendes gilt:

- Das Pdf Bildobjekt hat keinen der Filter JBIG2Decode, DCTDecode oder JPXDecode.

- Es hat keine Maske und ist keine Maske.

- Der Farbraum ist „DeviceGray“, „DeviceRGB“ oder „DeviceCMYK“ (mit BitsPerComponent 8).

- Der Eintrag „Decode“ fehlt oder ist der Standardeintrag für den jeweiligen Farbraum ([0 1] für „DeviceGray“, [0 1 0 1 0 1] für „DeviceRGB“, [0 1 0 1 0 1 0 1] für „DeviceCMYK“).

Für alle anderen Pdf Bildobjekte erfolgt die TIFF-Ausgabe über den Zwischenschritt als DIB-Format. In diesem Fall bleiben nicht alle Bild-Eigenschaften erhalten:

Erhalten bleiben auch bei dem DIB-Zwischenschritt:
Anzahl Pixel in Breite und Höhe des Bildobjekts.

Verändert können werden bei dem DIB-Zwischenschritt:
Colorspace, BitsPerComponent und ComponentsPerPixel

B.) JPEG-Bilder werden für Pdf Bildobjekte, die den folgenden Bedingungen genügen, direkt (ohne Umwandlung) erzeugt und immer als einzelne JPEG-Bilder gespeichert:
- Das Pdf Bildobjekt hat einen Filter „DCTDecode“.

- Es hat keine Maske und ist keine Maske.

- Der Farbraum ist „DeviceRGB“.
- Der Eintrag „/Decode“ fehlt oder ist [0 1 0 1 0 1].

Die Bildung des JPEG-Dateinamens erfolgt nach der gleichen Regel wie der Dateiname für die einzelnen TIFF-Dateien (siehe oben).

String

ExtractImagesCallback

(ab Version 1.17.0)

Adresse der Callback-Funktion, die von der CIB pdf toolbox beim Parsen des PDF-Dokuments jedesmal beim Extrahieren eines Bild-Objektes aufgerufen wird.

String

ExtractImagesUserdata

(ab Version 1.17.0)

Adresse des Speicherbereiches, in dem die extrahierten Bilddaten und ihr Hash-Wert übergeben werden.

String

OutputFormat

(ab Version 1.14.0)

FormatImage

Bei diesem Ausgabeformat erzeugt die CIB pdf toolbox bei einem Rendering-Vorgang mehrere Ausgabe-Grafikformate.  Dabei muss es sich um Raster-Grafikformate handeln.

Erforderlich ist:
RenderingEngine=“CIBRenderer“

Welche Grafikformate erstellt werden sollen, wird über die Property „ImageType“ definiert.

String

OutputFormat

(ab Version 1.14.0)

FormatSvg

Die CIB pdf toolbox gibt eine Grafikdatei im SVG-Format aus (Scalable Vector Graphics=skalierbare Vektorgrafik).
Dabei handelt es sich um die vom World Wide Web Consortium (W3C) empfohlene Spezifikation zur Beschreibung zweidimensionaler Vektorgrafiken, die auf XML basiert.

Name der erzeugten Ausgabe:
Outputfilename.svg

Erforderlich ist:
RenderingEngine=“CIBRenderer“

String

OutputFilename

Name der Ausgabedatei, mit der entsprechenden Extension.

PNG und JPEG: Pro Seite im PDF wird eine Datei ausgegeben. Der Name wird durch Anhängen einer laufenden Nummer eindeutig gemacht.

String

InputFilename

Name des Eingabe-PDFs

Es können auch mehrere PDFs, getrennt durch Semikolon, eingegeben werden.

String

AbortDocCallback

(ab Version 1.10.0)

Adresse der Callback-Funktion für Ausgabedokument per Speicherübergabe.
Schnittstellenbeschreibung siehe Kapitel „AbortDocCallback“

String

AbortDocCallbackPointer

(ab Version 1.10.0)

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

String

EventNotifier

(ab Version 1.24.0)

Der Pointer zu der Instanz der Callback-Klasse CibPdfEventNotifier wird dieser Property zugeordnet.

Damit kann die Ausgabe von RGB565-Daten in den Speicher ermöglicht werden.

Erforderlich für diese Funktionalität ist OutputFormat=FormatBmp und RenderingEngine=CIBRenderer

String

ImageAlign

(ab Version 1.8.6c)

Über die Property kann die Ausrichtung von Grafiken im PDF verbessert werden, wenn die Grafiken aneinander-hängen und nicht gedreht sind.

Bedingung:
RenderingEngine=CIBRenderer

0          Optimierung ist ausgeschaltet

1          Optimierung wird durchgeführt (default)

String

ImageScaling

(ab Version 1.9.7)

(ab Version 1.14.0)

Über die Property kann die maximale Größe der Grafik spezifiziert werden.
Breite;Höhe in px, bzw. Auflösung in dpi.

Gültige Werte:
[<Breite>px];[<Höhe>px] | <Auflösung>[dpi]

Achtung:
ImageScaling beinhaltet die Funktionalität von TiffResolution. Wenn beide Properties gesetzt sind, wird daher nur ImageScaling ausgewertet.
Im Falle der Auflösung ist nur die Angabe eines Wertes erforderlich, da nur eine für beide Achsen identische Auflösung unterstützt wird.

Beispiele:

ImageScaling=100px;200px
Maximale Höhe 200 px oder maximale Breite 100 px, je nachdem, welche Grenze zutrifft.

ImageScaling=;200px
Feste Höhe 200px, Breite beliebig

ImageScaling=200px
Feste Breite 200px, Höhe beliebig

ImageScaling=100dpi oder ImageScaling=100
Auflösung 100 DPI wird benutzt.

Erweiterung für den Einsatz der Property „ImageType“:

Bei Erzeugung mehrerer Grafikformate in einem Rendering-Vorgang können hier Grafikproportionen für jedes erzeugte Grafikformat spezifiziert werden. Die Werte sind in der gleichen Reihenfolge aufgelistet, wie die Grafikformate in der Property „ImageType“ definiert wurden. Zur besseren Lesbarkeit können die Wertepaare mit geschweiften Klammern gruppiert werden.
Die Eingabe von Leerwerten „;;“ ist möglich, dann greift die Default-DPI-Einstellung.

Beispiele:

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

ImageType=“jpg;bmp“
ImageScaling=“50px;50px;;“
Das JPG hat 50x50 px, das BMP die Default-DPI-Einstellung.

String

ImageType

(ab Version 1.14.0)

Über diese Property kann angegeben werden, welche Grafikformate die CIB pdf toolbox in einem Rendering-Vorgang erzeugen soll. Derzeit sind hier nur Raster-Imageformate möglich.

Erforderlich ist OutputFormat= FormatImage und RenderingEngine=“CIBRenderer“

Mögliche Werte sind:
jpg, jpeg, webp, bmp, bmplz4, jpegxr, png, tiff, tif

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

Name der erzeugten Grafikdateien:

Um für die diversen Ausgabeformate einer Grafikdatei eindeutige Dateinamen zu erreichen, wird von der CIB pdf toolbox der Dateiname folgendermaßen aufgebaut:
<OutputFilename>-image<Seitennummer>-copy<Kopienummer>.<Dateierweiterung>

Beispiel:

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

Ergibt die folgenden Dateien:
out-image00001-copy00001.png
out-image00001-copy00002.png
out-image00001-copy00003.tiff
out-image00002-copy00001.png
out-image00002-copy00002.png
out-image00002-copy00003.tiff

Hinweis:
Die Dateierweiterung von OutputFilename wird ignoriert, d.h. eine Datei „out.bmp“ wird nicht erstellt, sondern nur die in ImageType definierten Dateitypen.

String

Threads

(ab Version 1.15.0)

Über diese Property kann beim Renderingvorgang die Konvertierung in mehrere Grafikformate und das anschließende Schreiben der Dateien parallelisiert werden, was zu einer besseren Performance führt.

Erforderlich sind die Properties ImageType und RenderingEngine=“CIBRenderer“

Mögliche Werte:

N     Für die Erstellung der Grafikdateien werden maximal N Threads verwendet.

0      Keine Verwendung von Threads
(default, Verhalten der Vorversionen)

String

TiffResolution

Auflösung der Grafik-Ausgabe.
Defaultwert: 150 DPI

String

TiffStripSize

StripSize als Vielfaches von 8kB.

0 für keine,

Default ist 4, also 32kB-Strips

String

TiffJpegQuality

Nur bei TIFF:

Jpeg-Komprimierungsfaktor, Default ist 75%

String

TiffSinglePage

Nur bei TIFF:

Es kann pro PDF-Seite eine TIFF-Datei erzeugt werden.

0          Pro PDF eine TIFF-Datei (default)

1          Pro PDF-Seite eine TIFF-Datei

String

TiffColorDepth

Optionen für die Farbtiefe

Nur bei JPG und PNG:

2Colors

256Colors

256Grayscale

TrueColor (24Bit, Default)

Nur bei BMP:
(ab CIB pdf toolbox Version 1.24.0)

HighColor
Ausgabe gerenderter PDF Seiten als 16bpp BMP auf Platte oder als RGB565 Bitmaps in den Speicher.
(Erforderlich RenderingEngine=CIBRenderer)

String

WebviewOutputConfiguration

(ab CIB pdf toolbox Version 1.10.0)

ab CIB pdf toolbox Version 1.17.0)

Mit dieser Property kann die generierte Ausgabe für den CIB doxiView konfiguriert werden, sodass nur ein Ausgabeformat, statt standardmäßig Png und Metafile, erfolgt.

Mögliche Werte:

„Image“:          
bei gesetztem Wert wird pro Input-Dokumentseite ein Png-Bild für den CIB doxiView generiert

„Metafile“:       
bei gesetztem Wert wird pro Input-Dokumentseite ein Metafile für den CIB doxiView generiert

 „MetafileAsSingleFile“:
bei gesetztem Wert werden keine separaten Metafiles pro Seite geschieben, alle Informationen werden in ein Metafile geschrieben.

„MetafileNoPageContent“:      
schaltet die Verarbeitung von Seiteninhalt (page content streams) ab, als Folge werden Seiteninhaltsbezogene Metarecords wie z.B. TEXTRECT nicht ausgegeben. Die Metarecords STARTPAGE, ENDPAGE, EMBEDDEDFILE2 sind davon nicht betroffen.

„MetafileNoOutlines“:  
Schaltet die Verarbeitung von Outlines im PDF Dokument ab, als Folge werden keine Outlines Metarecords ausgegeben.

Die Werte „MetafileNoOutlines“, MetafileNoPageContent“ und „MetafileAsSingleFile“ können kumulativ verwendet werden. Sie sind nur dann gültig, wenn „WebviewOutputConfiguration“ so eingestellt ist, dass nur Metafiles erzeugt werden. Bei der Erzeugung von Bildern muss immer das gesamte PDF Dokument verarbeitet werden.

Beispiele:

Standardwert = „Image;Metafile“

Ab CIB pdf toolbox 1.20:

Zusätzlich kann die Option „ImageSkipAnnotations“ verwendet werden, um festzulegen dass für das CIB doXiview Rendering bestimmte Typen von Annotationen nicht in die Ausgabebilder gerendert werden.

Die Option „ImageSkipAnnotations“ hat dabei keine Auswirkungen auf die Ausgabe in ein Metafile.

Beispiel:

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

Es sind folgende Werte für Annotationstypen möglich: “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” :
Wenn gesetzt, wird im CIB doXiview Metafile ein neuer Metafile-record TEXTRECT2 geschrieben, der zusätzlich zu den Textinformationen noch Breiten für die einzelnen Zeichen schreibt.

String

SkipFormfieldContent

(ab CIB pdf toolbox Version 1.16.0)

Ermöglicht es, bei der Anzeige den Inhalt von Formularelementen (Textfelder, Checkboxen, Listenfelder) auszublenden.

Mögliche Werte:

0: Formularinhalte werden angezeigt

1: Formularinhalte werden nicht angezeigt

In Verbindung mit OutputFormat=FormatWebview zu verwenden.

ZUGFeRDXml

Angabe einer ZUGFeRD kompatiblen XML-Datei, die dann ZUGFeRD-kompatibel in das PDF eingebettet wird.

Bei OutputFormat=FormatInfo wird die Property ZUGFeRDXml mit dem Namen des Zugferd XMLs belegt, falls im Eingabe-PDF bereits eines eingebettet ist.

String

ZUGFeRDSchema

Angabe einer Schema-Datei, gegen die die ZUGFeRD-XML-Datei beim Importieren oder Extrahieren überprüft werden kann.
Beispiel: Invoice.xsd

String

ZUGFeRDDoCheck

Eingabe, ob beim Extrahieren oder Importieren einer ZUGFeRD XML Datei ein Schema-Check durchgeführt werden soll.

Mögliche Werte:
0          kein Schema-Check (default)
1          Schema-Check wird durchgeführt

Ist in Property ZUGFeRDSchema keine Schema Datei angegeben, wird für den Schema-Check die in der ZUGFeRD-XML-Datei enthaltene Schema Datei verwendet.

Wenn die Schema-Überprüfung fehlschlägt, wird ein Error 355 ausgegeben.

String

ZUGFeRDDescription

In dieser Property kann eine Beschreibung der ZUGFeRD-XML-Datei hinterlegt werden. Diese Beschreibung wird bei Einbetten der XML-Datei mit in das PDF übernommen.

Eingabe: Beliebiger Text

String

Bezeichnung

Wert

Auswirkung

ApplyRedactAnnotations

= 0  (default)

= 1 Schwärzung wird durchgeführt

Bei gesetzter Property schwärzt die CIB pdf toolbox die in den Annotations angegebenen Bereiche.

Redaction (Schwärzen) geschieht in folgenden Schritten:

1.     XFDF-Datei wird mit den Redaction-Annotations erstellt.

2.     CIB pdf toolbox importiert diese Annotations ins PDF-Dokument über „AnnotationsFilename=abc.xfdf“
Ergebnis ist dann ein PDF, das die zu schwärzenden Bereiche enthält.

Beispiel zu XFDF-Datei

<?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>

Hinweis:

-> Die Seitennummern werden in zerobased angegeben.

-> Die gewünschten Koordinaten setzt man mit der Vorgabe eines Rechtecks(rectangle)

rect="66.0,474.0,152.0,393.0" -> wobei als Einheit PDF Koordinaten verwendet werden (1 cm entspricht 28,333... PDF Koordinaten). Das Rectangle wird angegeben als x,y linke untere Ecke und x,y rechte obere Ecke. Der Ursprung (Koordinate 0,0) der Seite befindet sich links unten.