CIB pdf toolbox technischer Leitfaden (DE)

AnnotationsFilename

(ab CIB pdf toolbox 1.4.105)

String

Eingabedatei bzw. Speicherbereich im XFDF-Format, die die Kommentare enthält, die ins PDF importiert werden sollen.

Dies entspricht der Funktion „Kommentare importieren“ im Acrobat von Adobe.

Set

AnalysisFilename

(ab CIB pdf toolbox 1.14.4)

String

Schreibt Informationen über die Eigenschaften einer PDF Seite in eine Logdatei.

Syntax:
AnalysisFilename=“out.txt“

Die Analysedatei enthält derzeit nur Informationen über die Seitengröße und Ausrichtung.

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

Es liegen 2 Seiten vor, mit den angegebenen Abmessungen in mm und jeweils den Ausrichtungen Hochformat und Querformat.

Diese Property kann mit der Property OutputFormat=FormatInfo kombiniert werden, so dass kein Ausgabedateiname angegeben werden muss.

Set

AntiAliasing

String

Einschalten der AntiAliasing-Funktionalität.

0     Kein AntiAliasing (default)

2     x2 AntiAliasing-Funktionalität für interne und Pango Rendering-Engine.

4     x4 AntiAliasing-Funktionalität für interne und Pango Rendering-Engine. (siehe auch RenderingEngine parameter)

Set

BookmarkAlignment

(ab CIB pdf toolbox 1.4.84)

String

„0“ = Kein Einfügen von Leerseiten

„1“ = Jede Ausfertigung wird durch Leerseiten auf eine gerade Seitenzahl erweitert.

Nur sinnvoll bei PDF-Join ohne OutputFormat=FormatPrinter.

Set

CallbackPointer

String

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

Get/
Set

ColorDithering

(ab CIB pdf toolbox 1.4.86)

String

Ist diese Property gesetzt, werden bei der Ausgabe (als Bitmap oder beim Druck) alle Farbwerte in Schwarzweiß-Muster umgerechnet. Das Muster ergibt sich dann aus der Helligkeit des Farbwerts.

Mögliche Werte:
0          Keine Umrechnung (default)
1          Umrechnung

Get/
Set

Data

String

Angabe der Eingabedatenquelle.
Das Einmischen der Daten erfolgt durch den Modul PdfMerge

Syntax:

Data=<Datentyp>:<Dateiname>

<Datentyp>= leer  (CSV wird angenommen)

            CSV
            XML
            ADOBE.XFDF
            TYP

TYP: weitere Datentypen (z.B. SQL), die über die DataAccess-Schnittstelle abgewickelt werden.

<Dateiname>=datei.typ

            X:\datei.typ

            Datei.xml;//xpath

Falls es sich bei der Datendatei (CSV, XML) um eine Multisteuerdatei handelt, muss MultiData=1 gesetzt werden.

Beispiel:
Data=ADOBE.XFDF:Input.xfdf

Get/
Set

DataFileMemoryAddresses

String

Speicheradresse+Länge der Datendatei bei Speicherübergabe

Get/
Set

DataFileType

String

Datentyp für Datenquelle per Speicherübergabe

Get/
Set

DataXmlPath

String

Eingaberequest, z.B. „XML:data.xml;//root/...“ für Datenquelle per Speicherübergabe

Get/
Set

DataXslFilename

String

Name der Xsl-Transformationsdatei (für Transformation von Adobe-xfdf Formulardatenexport)

Get/
Set

DocumentUsedBookmarks

(ab CIB pdf toolbox 1.4.105)

String

Ausgabe der in einem Dokument verwendeten Textmarken.
Zu jeder Textmarke werden die Seiten angegeben, die sie beinhaltet. Dabei kann es sich um Einzelseiten und/oder einen oder mehrere Seitenbereiche handeln.

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

<Textmarke> ::= „{“ <Text> „;“ <Seitenliste> „}“

<Seitenliste> ::= <Seiten> | <Seiten> „,“ <Seitenliste>

<Seiten> ::= <Zahl> | <Zahl> „-„ <Zahl>

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

Get

EmbeddedFileOutputFormat

String

„None“: Die Streams der eingebetteten Dateien werden nicht extrahiert (Default).

„FormatEmbedded“: Die Streams der eingebetteten Dateien werden in das Metafile geschrieben.

„FormatFile“: die eingebetteten Dateien werden in das aktuelle Arbeitsverzeichnis extrahiert.

Set

EmbeddedFilesExtract

String

Ein JSON-Array von JSON-Objekten, die definieren, welche Dateien

exportiert werden. Ein JSON-Objekt sieht wie folgt aus:

- Datei: Dateiname wie im pdf angegeben

- OutputFilename: Wo die Datei gespeichert werden soll.

Set

EnablePatternsShadings

(ab CIB pdf toolbox 1.14.0)

String

Die Property steuert, ob PDF-Shadings und PDF-Patterns mit gerendert werden oder nicht.

1     PDF-Shadings und PDF-Patterns werden mit gerendert (Default)

0     PDF-Shadings und PDF-Patterns werden nicht mit gerendert.

Erforderlich: CIB renderer

Set

ExtractEmbeddedFile

(ab CIB pdf toolbox 1.8.0)

String

Über Belegung dieser Property kann gesteuert werden, dass die CIB pdf toolbox während eines Join-Laufs eine eingebettete Datei extrahiert.

Mögliche Eingaben:
- Dateiname, wie er im PDF hinterlegt ist.
- Nummer der Datei im PDF (z.B. „1“ bedeutet: Die erste Datei, die im PDF hinterlegt ist)

- „zugferd“: Die ZUGFeRD-XML-Datei wird extrahiert.
(ab CIB pdf toolbox 1.9.0)

Der Name, unter dem die eingebettete Datei herausgeschrieben wird, wird über die Property OutputFilename übergeben.

Set

ExtractEmbeddedFileInfo

String

„1“ = Die Informationen der eingebetteten Dateien werden in das Metafile geschrieben (Name, Dateigröße, Datum der Erstellung und letzten Änderung) (Default).

„0“ = Es werden keine Informationen zu eingebetteten Dateien in das Metafile geschrieben.

Set

ExtractXmpMetadata

String

Ermöglicht das entpacken von XMP-Metadaten aus einer PDF-Datei.

Die Property hat JSON Syntax.

Beispiel:

{

„1“: „<filenameforfirstpage>“, // extrahiert xmp von Seite 1
“2“: „<filenameforSecondpage>“,
“Global“: „<globalXMP>“

}

„<Zahl>“ Entpackt die XMP-Metadaten einer spezifischen Seite

„Global“ entpackt die globalen XMP-Metadaten des PDF-Dokuments (aus dem Catalog Dictionary)

„AllPages“ entpackt alle Seiten-XMP-Metadaten

FieldCaptions.
<utf8prefix>FieldCaptions.
(ab CIB pdf toolbox 1.4.82)

String

dynamische Property, Beschriftung eines Formularfelds (z.B. FieldCaptions.Radio123)

Der Wert der Property ist

bei Pushbuttons: Eine durch „;“ getrennte Liste der Pushbuttonlabels.  als Ansi-String oder als Utf8-String. (es kann mehrere Pushbuttons mit gleichem Namen geben, auch mit unterschiedlichen Labels)

bei Radiobuttons und Checkboxen: Eine durch „;“ getrennte Liste, die den Stil für jeden Button der Gruppe angibt. Die Reihenfolge ist die gleiche wie bei FieldStates (außer „Off“). Mögliche Stile sind:

„n“ = Quadrat (square)

„u“ = Raute (diamond)

„4“ = Haken (check)

„8“ = Kreuz (cross)

„H“ = Stern (star)

„l“ = Kreis (bullet)
Der Button ist genau dann kreisförmig wenn die Caption das bullet ist. Ansonsten ist der Button quadratisch.

Get

FieldDimensions.

String

dynamische Property, Koordinaten eines Formularfelds (z.B. FieldDimensions.Feld123)
Format: „page, (x1,x2,y1,y2)“

Get

FieldFlags.

String

Dynamische Property, Eigenschaften eines Formularfelds (z.B. FieldFlags.Feld123)

Der Inhalt ist eine durch „;“ getrennte Liste der Eigenschaften, die für das Feld „Feld123“ gesetzt sind. Folgende Eigenschaften sind möglich:

ReadOnly         Schreibgeschützt

Required          Erforderlich

NoExport         Beim Exportieren des Formulars dieses Feld    ignorieren

Multiline          mehrere Zeilen (nur bei Textfeldern)

Password         geschützte Eingabe (*****) (nur bei Textfeldern)

NoToggleToOff            Auswahl kann nicht auf leer gesetzt werden (Radiobutton)

Radio     redundant, siehe FieldType.<name>

Pushbutton      redundant, siehe FieldType.<name>

Combo  redundant, siehe FieldType.<name>

Edit       benutzerdefinierte Eingabe erlaubt (nur bei Comboboxen)

Sort       Auswahl sortieren (List- und Comboboxen)

FileSelect          Feld ist Auswahl für Dateiname

MultiSelect       Mehrfachselektion (nur bei Listbox)

DoNotSpellCheck         keine Rechtschreibprüfung

DoNotScroll     kein horizontales Scrolling (limitiert Textlänge)

Comb    Text in Kästchen

RadiosInUnison            Buttons mit demselben Exportwert synchron an- und abschalten

CommitOnSelChange   ausgewählten Wert sofort einsetzen (nicht erst beim Verlassen des Feldes)

RichText Feld enthält „rich text“ (kein rtf, sondern Text mit ein paar html-tags wie <b>,<i>)

Get

FieldFont.

String

dynamische Property, Schriftart und -größe des Formularfeld-Textes

Get

FieldNames

String

Liste der Namen der Formularfelder im Dokument, durch „;“ getrennt

Get

FieldOptions.

String

dynamische Property, Optionen eines Formularfelds (z.B. FieldValue.Feld123)
Bei List- und Comboboxen die Texteinträge durch „;“ getrennt

Get

FieldOrder.

String

dynamische Property, Laufende Nummer des Formularfelds (unsortiert)

Get

FieldStates.

String

dynamische Property, Ausprägungen eines Formularfelds (z.B. FieldValue.Checkbox123)

Get

FieldType.

String

dynamische Property, Typ eines Formularfelds (z.B. FieldType.Textfeld123)

Get

FieldValue.

String

dynamische Property, zum Setzen oder Auslesen von Formularfeld-Inhalten (z.B. FieldValue.Textfeld123)

Durch Setzen dieser Property an den Modul PdfMerge können Inhalte von Formularfeldern übergeben und in das PDF eingemischt werden. (z.B. FieldValue.Textfeld123=Test)
(ab Version 1.4.84)

Get/Set

FillTextOutput

(ab CIB pdf toolbox 1.27.0. )

String

Diese Optionen wirken sich nur aus, wenn die Ausgabe Format-Option folgendermasen gesetzt ist: OutputFormat=FormatText (für die Ausgabe von reinem Text), oder OutputFormat=FormatHocr (für die Ausgabe von HOCR-Text).

Wenn die Option FillTextOutput auf 0 gesetzt ist:

            Der extrahierte Text wird nur in die     Ausgabedatei ausgegeben. Wenn             der Ausgabedateiname nicht   innerhalb der Option   OutputFilename gesetzt ist, sollte          ein Fehler erscheinen.

Wenn die Option FillTextOutput auf 1 gesetzt ist:

            Der extrahierte Text wird in die            Ausgabedatei ausgegeben und             zusätzlich in die Ausgabeeigenschaft   TextOutput in Utf8-Kodierung             kopiert.

Hinweis:

Wenn FillTextOutput auf 1 gesetzt ist und OutputFilename nicht gesetzt ist, wird der extrahierte Text nur in der Property TextOutput gespeichert.

Set

FontsEmbedded

(ab CIB pdf toolbox 1.10.0)

String

Wird dieser Wert gesetzt, so werden alle im PDF-Dokument verwendeten Fonts in das PDF Ausgabe-Dokument eingebettet.

Mögliche Werte:

„0“       kein Einbetten (default)

„1“       Fonts werden einbettet.

Hinweis:
Im Falle von PDF/A-Konvertierung wird FontsEmbedded automatisch aktiviert.

Set

FontSubstitution

(ab CIB pdf toolbox 1.10.0)

String

Die Property gilt wenn FontsEmbedded=1 oder PdfVersion=PDF/Axx.

Alle im System nicht verfügbaren Fonts müssen ersetzt werden. Über diese Property kann gesteuert werden, welche Fonts für die Ersetzung verwendet werden.

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

Im Detail:

• Im Ziel-System vorhandene Fonts werden ohne Ersetzung eingebettet.
• Im Ziel-System nicht vorhandene Fonts werden ersetzt. Befindet sich der Font in Liste der Property FontSubstitution?
• Ja:
  Der dort angegebene Ersatzfont wird eingebettet.
• Nein:
  Der Default-Ersatzfont wird eingebettet.

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

Hinweise:

• Die CIB pdf toolbox macht eine FontSubstitution nur, wenn der andere Font kompatibel ist.
  D.h. ein symbolic Font(z.B. Wingdings) wird nicht durch einen nonsymbolic(z.B. Times New Roman) ersetzt oder umgekehrt, ein CID wird nicht durch einen Nicht-CID Font ersetzt oder umgekehrt.
• Im Fall einer nicht durchgeführten, aber per Property gesetzten, Fontsubstitution wird mit Rückgabewert 352 beendet.
• Durch fontspezifische Eigenschaften z.B. Buchstabenbreite, kann es im Fall einer Fonsubstitution zu Veränderungen im Layout kommen. Dieses ist vom Benutzer auf Korrektheit zu prüfen.

Set

FontWorkSpace

String

Pfad zum Verzeichnis, in dem die Fonts gespeichert sind, die beim Rendern des PDFs in Bildformat verwendet werden sollen.
Es wird sowohl von Interner- also auch von der Pango Rendering-Engine verwendet (siehe auch Property RenderingEngine).

Set

FormfieldNamePrefix

String

Präfix für alle Formularfelder eines Dokuments, bzw. eine durch „;“ getrennte Liste von Präfixen für die am Join beteiligten Dokumente.

Set

GeneratedDocumentCount

(ab Version 1.4.83)

String

Liefert die Anzahl der erzeugten Ausgabedokumente.

Im Normalfall wird „1“ zurückgeliefert, außer bei MultiOutput=1, wenn mehrere Ausgabe-PDFs erstellt werden.

Im Fehlerfall, d.h. Abbruch und gar keine Ausgabe, wird „0“ zurückgegeben.

Get

GeneratedPageCount

(ab Version 1.8.1)

String

Liefert die Anzahl der ausgegebenen Seiten.

Beim Druck werden die erzeugten Kopien mitgezählt. Bei Ausgabe einer Datei ist die Anzahl identisch zu der aus PageCount.

Im Fehlerfall, d.h. Abbruch und gar keine Ausgabe, wird „0“ zurückgegeben.

Get

GetFieldInfo

String

Über diese Property kann die Abfrage der Formularfelder ermöglicht werden.

Mögliche Werte:

„1“       Die Formularfelder können
            abgefragt werden

„0“
„“         Keine Abfrage möglich (default)

Get/
Set

GetPageInfo

String

Über diese Property kann eine Versorgung der GET-Property „PageInfo.<seite>“ veranlasst werden.

Mögliche Werte:

„1“       Die Property „PageInfo.<seite>“
            wird belegt.

„0“
„“         Keine Belegung (default)

Get/
Set

ImageInfo

Abrufen einer Beschreibung über Bilder in einer PDF-Datei in JSON Format.

Get

ImagePdfCreation

String

Mögliche Werte:

„0“ oder leer: Property hat keinen Effekt.

„1“ CIB pdf toolbox verwendet CIB renderer um Inhalt von PDF Seiten als Grafik zu erzeugen.

Set

ImagePdfCreationPreserveText

String

Tritt der PdfAFallback Fall ein (siehe Kapitel 5.1.4.1.), können mit Setzen dieser Property Textinhalte aus der Eingabedatei über HOCR Export gesichert und in die Ausgabedatei übernommen werden.

Mögliche Werte:

„0“: Property hat keinen Effekt.

„1“: Textinhalte der Eingabedatei werden in die Ausgabedatei übernommen

Set

IndDCAntiAliasing

String

Wird nicht mehr verwendet

“2” – Einschalten x2 anti-aliasing Funktionalität für interne Rendering-Engine

“4” – Einschalten x4 anti-aliasing Functionalität für interne Rendering-Engine (siehe Proprety RenderingEngine);

Default: “0” oder leer (Es wird kein anti-aliasing durchgeführt)

Set

HiddenPages
(ab CIB pdf toolbox 1.8.0)

String

CIB-interne Property, die derzeit nur vom CIB image unterstützt wird.

Über diese Property gibt ein CIB-Viewer an, welche Seiten bei der Anzeige durch einen CIB viewer ausgeblendet werden sollen. Diese Information wird mit CIB-mitteln im PDF gespeichert.
(Analog zum Ausblenden von Powerpoint-Folien in Powerpoint).

Set

IgnoreTemporaryFontFailure

(ab CIB pdf toolbox 1.8.0)

String

Über diese Property kann die Reaktion auf Fehler bei der temporären Installation von Schriften aus dem PDF gesteuert werden.

Mögliche Werte:

1         Fehler werden ignoriert und die Verarbeitung fortgesetzt

0         Fehler werden mit einem Rückgabewert, z.B. 350, quittiert und die Verarbeitung beendet. (default)

Set/
Get

IncludeInvisibleText
(ab CIB pdf toolbox 1.5.114)

String

Diese Property steuert, ob unsichtbarer PDF-Text (Rendering Mode = 3) von der CIB pdf toolbox ausgegeben wird oder nicht.

Mögliche Werte:

„1“  Unsichtbarer PDFdf-wird bei bestimmten Toolbox-Aufrufen genauso ausgegeben wie sichtbarer Pdf-Text.

„0“  Unsichtbarer Pdf-Text wird bei diesen Toolbox-Aufrufen nicht ausgegeben.
(= default)

Diese Property ist nur bei folgenden Toolbox-Aufrufen wirksam:

a)   Bei der Toolbox-Textsuche mit PdfSearchText=“…“.

b)   Bei der Ausgabe des Pdf-Files in den OutputFormaten „FormatText“ oder „FormatCsv“.

c)    Bei der Ausgabe des Pdf-Files im OutputFormat „FormatXfdf“, wenn die Property „RegionTemplate“ nicht leer ist.

d)    Bei der Metafile-Ausgabe für CIB webview (OutputFormat ist „FormatWebview“).

Set

InputFilename

String

Eingabedatei bzw. eine durch „;“ getrennte Liste von Eingabedateien bzw. Paare {x};y von Seitenangabe(n)/Eingabedatei bzw. leere Seite(n) EMPTY[:Breite(mm), Höhe(mm)].

InputFilename=

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

{5,4,1-3};Dokument2.pdf;EMPTY heißt, dass alle ungeraden Seiten von Dokument1.pdf, eine leere Seite der Breite 210 mm und der Höhe 297mm, die Seiten 5, 4, 1, 2 und 3 von Dokument2.pdf und eine leere Seite mit der Breite und Höhe der aktuell letzten Seite (Seite 3 von Dokument2.pdf) in genau dieser Reihenfolge aneinandergefügt werden.

Syntax:

InputFilename ::= <Eingabedatei> [“;“ <Eingabedatei>]...

Eingabedatei ::= [<Seitenangaben> „;“] (<Filename> | <Speicherblöcke> | <Leerseite> | <Speicherblock-Delimiter>)

Seitenangaben ::= „{“ <Seitenangabe> [“,“ <Seitenangabe>]... „}“

Seitenangabe ::= „All“ |“Even“ | „Odd“ | „First“ | „Last“ | <nummer> | (<startnummer> „-„ <endnummer>)

Leerseite ::= „EMPTY“ [“:“ <Breite_in_mm> „,“ <Höhe_in_mm>]

Speicherblöcke ::= <Speicherblock> [<Speicherblock-Delimiter> <Speicherblock>]...

Speicherblock ::= <Adresse> <Speicherblock-Delimiter> <Länge>

Ein <Speicherblock-Delimiter> ist ein einzelnes Zeichen ungleich „;“, das möglichst nicht in einem Filenamen vorkommt, z.B. „#“, „?“.

Adresse und Länge sind Dezimalzahlen

Get/
Set

InputMemoryAddress

String

Paare xxx?yyy von Speicheradresse/Länge

Zu beachten:
Der Delimiter ist eine Muss-Angabe und die Adresse ist dezimal einzugeben.

Get/
Set

InsertEmptyPageInDuplex

(ab CIB pdf toolbox 1.4.83)

String

„0“ = Keine DuplexLeerSeiten beim Druck einfügen(default)

„1“ = Beim Duplexdruck von PDF-Dokumenten mit der CIB pdf toolbox werden bei ungerader Seitenanzahl zwischen den zusammengefügten PDF-Dokumenten automatisch Leerseiten eingesteuert. Die Identifizierung dieser Trennstellen erfolgt durch Auswertung der hinterlegten Markierungen. Diese Markierungen, werden über die Property JoinHistory gesetzt.

(weitere Details, siehe Property JoinHistory)

Get/
Set

InsertEmptyPageBetweenRtfBookmarks

 (ab CIB pdf toolbox 1.4.83)

String

“0” = Keine DuplexLeerSeiten beim Druck einfügen(default)

„1“ = Beim Duplexdruck von PDF-Dokumenten wird zwischen den Stellen, wo sich eine RtfBookmark ändert, bzw. wo ein  Join gemacht wurde (siehe Property JoinHistory), eine Leerseite beim Druck eingefügt, wenn der darauffolgende Inhalt auf eine Rückseite gedruckt werden würde.

Get/
Set

JoinHistory

(ab CIB pdf toolbox 1.4.83)

String

„0“ = Die CIB pdf toolbox setzt keine Markierung an den Seitenübergängen, an denen dieses aus mehreren Einzeldokumenten zusammengefügt wird.

„1“ = Die Toolbox markiert diese Position(en).

Hinweis:

Damit ist es möglich, einen späteren Ausdruck im Duplexmodus mit automatisch eingefügter Leerseite vorzunehmen.

Siehe auch Property InsertEmptyPageInDuplex und

InsertEmptyPageBetweenRtfBookmarks

Der Defaultwert ist 1

Get/
Set

StartPage
(ab CIB pdf toolbox 1.8.0)

String

In dieser Property kann die Seitennummer hinterlegt werden, bei der das PDF bei der Anzeige geöffnet wird.

Die Nummer wird im PDF hinterlegt und bei der Anzeige durch den Adobe Reader, CIB jView oder CIB image ausgewertet.

Set

OpenSize

(ab CIB pdf toolbox 1.13.5)

String

Gibt die Zoomstufe im Fenster des PDF-Anzeigeprogramms beim Öffnen der PDF-Datei vor.

„Standard“       Standardeinstellung des PDF-
                        Anzeigeprogramms verwen-
                        den (Default)

„Fit“                 An Fensterhöhe anpassen

„FitH“               An Fensterbreite anpassen

Kommt nur zur Anwendung, wenn auch StartPage gesetzt ist.

Set

PartialDocumentAlignment

(ab CIB pdf toolbox 1.4.84)

String

„0“ = Kein Einfügen von Leerseiten

„1“ = Jedes Teildokument wird durch Leerseiten auf eine gerade Seitenzahl erweitert.

Nur sinnvoll bei PDF-Join ohne OutputFormat=Printer.

Set

PdfPrintFontCleanupInterval

(ab CIB pdf toolbox 1.4.95)

String

Angabe eines Zeitintervalls, nach dem die CIB pdf toolbox Fonts aus der Fontliste entfernt. Damit kann verhindert werden, dass Fonts zu früh aus der Fontliste gelöscht werden.

Einheit: Stunden
Default: 0

Bei jedem Aufruf prüft die CIB pdf toolbox die Fontliste. Diese enthält die noch nicht abgeräumten Fonts mit einem Zeitstempel. Alle Fonts älter als das FontCleanupInterval werden aus der Liste entfernt.

Bei wiederholten Aufrufen von CibPdfMerge/ CibPdfJoin/CibPdfPrint im gleichen Prozeß wird die Fontliste nur geprüft, wenn seit dem letzten Aufruf mindestens 1 Stunde vergangen ist.

Set

LicenseKey

String

Lizenzschlüssel

Set

LicenseCompany

String

Lizenznehmer

Set

MaxResolution

(ab CIB pdf toolbox 1.5.111)

String

Durch Angabe einer maximalen Auflösung (in dpi) kann die Größe von Grafiken im Metafile begrenzt werden.

Das wirkt sich war auf die Qualität (etwa beim Zoomen) aus, die Metafiles werden jedoch kleiner.

Default: Original-Auflösung wird beibehalten.

Im Acrobat gibt es dieses Feature bei „Erweitert/Pdf-Optimierung“ und heißt „Bikubische Neuberechnung auf ... dpi für Bilder ab ... dpi“. Die CIB pdf toolbox führt die Neuberechnung (Resampling) nur beim Speichern als Metafile durch, nicht beim Speichern als PDF. Außerdem wird ein einfacherer (nicht bikubischer) Resampling-Algorithmus verwendet.

Set

ResolutionThreshold

(ab CIB pdf toolbox 1.5.111)

String

Alle Bitmaps im Dokument, die eine höhere Auflösung haben als ResolutionThreshold (in dpi), werden auf MaxResolution herunterskaliert und dann ausgegeben. Das ist unabhängig von der Auflösung des Ausgabemediums (Bitmap, Drucker, Metafile).

Setzt man nur MaxResolution, dann werden alle Bilder mit höherer Auflösung auf MaxResolution herunterskaliert.

Set

MemoryOutputCallback

String

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

Get/
Set

MemoryOutputUserdata

String

Userdata der Callback-Funktion für Ausgabedokument per Speicherübergabe

Get/
Set

MetaFilename

String

Name des Metafiles, welches mit den CIB viewern angezeigt wird.

Set

MultiData

String

„1“ = Datendatei ist eine Multisteuerdatei

Get/
Set

MultiOutput

String

„1“ = Pro Datensatz eigene Ausgabedatei erzeugen

Get/
Set

NeedAppearances

String

„1“ = Acrobat baut die Formularfelder beim Öffnen neu auf.

Get/
Set

OutputFilename

String

Dateiname des Ausgabe-Dokuments

Get/
Set

OutputFormat

String

(keins): Dokument wird über OutputFilename gespeichert.

“FormatPdf“: Ausgabe ist ein PDF (default)

“FormatView“: Es wird ein temporäres Metafile für CIB view erzeugt.

“FormatJavaView“: Es wird ein temporäres Metafile für CIB jView erzeugt.

“FormatEmbeddedFile“: Es werden nur die im Dokument eingebetteten Dateien gelesen und gespeichert. Der Rest des Dokuments wird nicht bearbeitet.
Das Ausgabeformat wird mittels der Property “EmbeddedFileOutputFormat“ festgelegt.

“FormatPrinter“: Dokument wird auf den Drucker ausgegeben.

„FormatText“: Das Ausgabeformat ist plain Text (als Unicode).
(ab CIB pdf toolbox 1.4.81)

Auch für dieses Ausgabeformat wird ab CIB pdf toolbox 1.4.87 das Memory-Interface unterstützt.

Wenn der Inhalt von Formularfeldern in den Textoutput übernommen werden soll, muss die Property FlattenFormfields=1 gesetzt werden.

„FormatXfdf“: Der Modul PdfJoin exportiert die Formulardaten aus dem PDF als Xfdf-Datei. Diese Datei beinhaltet die Feldnamen und –inhalte im XML-Format.

(ab CIB pdf toolbox 1.4.90)

„FormatXfdfWithAnnots“: Der Modul PdfJoin exportiert aus dem PDF als Xfdf-Datei die Formulardaten und zusätzlich Kommentare und deren grafisches Erscheinungsbild.

Hier werden folgende Typen unterstützt:
text | caret | freetext | fileattachment | highlight | ink | line | circle |square | polygon | polyline | sound | squiggly | stamp | strikeout | underline

(ab CIB pdf toolbox 1.4.105)

„FormatSearchablePdf“: In Grafiken enthaltener Text wird alsText extrahiert.

(ab CIB pdf toolbox Version 1.6.116)

„FormatBarcodeXml“: Die aus dem PDF über die Property „BarcodeInfo“ ausgelesenen Barcodeinformationen werden im XML-Format ausgegeben.

(ab CIB pdf toolbox 1.8.0)

„FormatBarcodeCsv“: Die aus dem PDF über die Property „BarcodeInfo“ ausgelesenen Barcodeinformationen werden im CSV-Format ausgegeben.

(ab CIB pdf toolbox 1.8.0)

„FormatInfo“: Es werden globale Dokumenten-Eigenschaften durch den PDF-Join aus dem PDF ausgelesen.

(Ab CIB pdf toolbox 1.6.116f)

“FormatPrinterCups”:  Druckansteuerung über CUPS. Nur für Linux/Unix verfügbar. (siehe Kapitel 14.1.2 “Druck über CUPS” )

„FormatTiff“: Erzeugt Grafikdatei im Tiff-Format.
(ab CIB pdf toolbox Version 1.4.102)

„FormatPng“: Erzeugt Grafikdatei im Png-Format.
(ab CIB pdf toolbox Version 1.4.102)

„FormatJpeg“: Erzeugt Grafikdatei im Jpeg-Format.
(ab CIB pdf toolbox Version 1.4.102)

„FormatWebview“: Ausgabeformat für die Anzeige in CIB doXiview.
(ab CIB pdf toolbox Version 1.4.102)

“FormatWebP“: Erzeugt Grafikdatei im WebP-Format (verwendet verlustbehaftete und nicht verlustbehaftete Kompression).
(ab CIB pdf toolbox Version 1.9.0)

„FormatJpegXR“: Erzeugt Grafikdatei im JPEG extended range Format.
(ab CIB pdf toolbox Version 1.9.0)

„FormatBmp“: Erzeugt Grafikdatei im BMP-Format.
(ab CIB pdf toolbox Version 1.8.5a)

„FormatBmpLz4“: Erzeugt Grafikdatei im BMP-Format, wobei Daten nach lz4 Standard komprimiert sind.
(ab CIB pdf toolbox Version 1.8.5a)

„FormatImage“: Bei einem Rendering-Vorgang werden mehrere Ausgabe-Grafikformate erzeugt. Dabei muss es sich um Raster-Grafikformate handeln.
(ab Version 1.14.0)

„FormatSvg“: Ausgabe einer Grafikdatei im SVG-Format (Scalable Vector Graphics=skalierbare Vektorgrafik).
(ab Version 1.14.0)

”FormatAnalyse”: Der Prüf-Prozess zum Verifizieren der Signatur wird immer komplett durchgeführt und die SignedDocument.xxx-Properties für die Signatur gesetzt. Dadurch kann verfolgt werden, welche Verarbeitungsschritte erfolgreich waren und welche nicht.
(Ab CIB pdf toolbox Version 1.6.115)

“FormatExtractImages”: Bei Angabe dieses Ausgabeformats werden alle Image-XObjects, die sich in den Eingabe-PDFs befinden, exportiert. Die Ausgabe erfolgt im TIFF-Format oder (bei bestimmten Pdf Bildobjekten) ins JPEG-Format unter der bei OutputFilename angegebenen Dateibezeichnung.
(ab CIB pdf toolbox Version 1.4.113)

„FormatCsv“: Aus dem PDF extrahierter Text wird als CSV-Datei ausgegeben.
(ab CIB pdf toolbox Version 1.4.95)

Get/
Set

OutputRtfBookmarkNames

Wenn die Option OutputRtfBookmarkNames=1 und PageSelection-Option unter Verwendung von CIB-Bookmark gesetzt ist, dann enthalten die Namen der Ausgabebilder Lesezeichennamen:

Das Format ist OutputRtfBookmarkNames=0:

<OutputFilename> - <Seitenzahl>

Beispiel: out-000001.png

Das Format ist OutputRtfBookmarkNames=1(erweiterte Ausgabe):

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

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

PageCount

String

Anzahl Seiten im Dokument, Dezimalzahl als String.

Get

PageFieldNames.<seite>

String

Gibt die Formularfelder jeder Seite zurück.

Z.B. PageFieldNames.0 enthält die Formularfelder der ersten Seite

Get

PageInfo.<seite>

String

Dynamische Property, in der Informationen zu einer Seite zurückgegeben werden (Breite, Höhe und Rotation).
(Property GetPageInfo muss gesetzt sein)

Z.B. PageInfo.1 enthält die Informationen zur zweiten Seite

Get

PdfDocPropertyEncoding
(ab CIB pdf toolbox 1.4.78)

String

“” = kein Encoding(default)

“Base64” = Base64 Encoding

Get/
Set

PdfDocProperties
(ab CIB pdf toolbox 1.4.78)

String

Liefert die Namen, durch „;“ getrennt, aller benutzerdefinierten Dokumenteigenschaften.

Get

PdfDocProperties
(ab CIB pdf toolbox 1.4.78)

String

Setzen neuer oder zu ändernder benutzerdefinierter Dokumenteigenschaften.

Set

PdfDocProperty.<name>

(ab CIB pdf toolbox 1.4.78)

String

dynamische Property, Lesen oder Setzen des Wertes der benutzerdefinierten Dokumenteigenschaft, deren Namen über die Property PdfDocProperties geliefert werden. Das Encoding des Wertes erfolgt entsprechend der Property „PdfDocPropertyEncoding“.

Achtung: neue Dokumenteigenschaften müssen über die Property „PdfDocProperties“ vorher bekannt gemacht werden. Bei Angabe von unbekannten Dokumenteigenschaften liefert die CIB pdf toolbox den Rückgabewert 99.

Get/
Set

PdfLinearized

String

Steuerung, ob das Ausgabe-PDF für die schnelle Anzeige im Web optimiert wird.

Mögliche Werte:
“0“       keine Optimierung (default)
“1“       Optimierung wird durchgeführt

Get/
Set

PdfSearchIgnoreCase

String

Steuerung, ob bei der Suche im PDF die Groß-/Kleinschreibung berücksichtigt wird.

Mögliche Werte:
“0“       nicht case-sensitive (default)
“1“       case-sensitive Suche

Set

PdfSearchFont

String

Setzen eines bestimmten Fonts. Bei einer nachfolgenden Textsuche werden als Ergebnis nur Texte geliefert, die mit diesem Font im Dokument vorkommen.

Beispiel:

PdfSearchFont=“CourierNewPS-ItalicMT“ bedeutet, dass im Dokument nur Textpassagen gesucht werden, die diesen Font verwenden.

Achtung:

Die Fontbezeichnung muss mit der vom Acrobat-Reader aus den Dokument-Eigenschaften übereinstimmen.

Set

PdfSearchResult

String

Liefert die Fundstellen der Zeichenkette im Dokument. Jede Fundstelle wird durch eine Folge von Rechtecken beschrieben. Diese bezeichnen die genaue Position der gesuchten Zeichenkette im Seitentext.

Eine Rechteck wird angegeben durch:

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

Erstreckt sich eine Fundstelle über mehrere Zeilen, wird eine Folge von Rechtecken durch Semikolon voneinander getrennt zurückgeliefert.

Beispiele:
PdfSearchResult=

„1,500,100,600,110;1,50,111,100,121“ heißt, dass sich der Suchtext auf Seite 1 über zwei Zeilen erstreckt. Einmal von (500,100) bis (600,110) und von (50,111) bis (100,121).

Kommt der Suchtext mehrmals im Dokument vor, so werden die verschiedenen Fundstellen (gekennzeichnet durch {}) aneinandergereiht.

„{1,500,100,600,110;1,50,111,100,121};{2,500,100,600,110;2,50,111,100,121}“ heißt dass der Suchtext auch noch auf Seite 2 von (500,100) bis (600,110) und von (50,111) bis (100,121) vorkommt.

Eine Fundstelle kann sich auch über mehrere Seiten erstrecken.

Ein Ergebnis wie

„1,500,750,600,760;2,50,50,100,60“ bedeutet, dass die Fundstelle auf Seite 1 von (500,750) bis (600,760) geht und sich auf Seite 2 von (50,50) bis (100,60) fortsetzt.

Get

PdfSearchResultContext

(ab CIB pdf toolbox 1.4.80)

String*

Liefert die Fundstellen der Zeichenkette im Dokument mit ihrem Kontext.
Zeichenkette wie in PdfSearchText und Kontext wie in PdfSearchContext beschrieben.

Das Suchergebnis ist folgendermaßen aufgebaut:

={<Fundstelle1>};{<Fundstelle2>};...

<Fundstelle> = {<Kontext>};<Rechteck1>;<Rechteck2>;...

<Rechteck> = siehe PdfSearchResult

<Kontext> = <Vor-Kontext> <Suchkette> <Nach-Kontext>

Falls nicht genügend Zeichen im Dokument vorhanden sind um den definierten Vor- oder Nachkontext zu belegen (z.B. am Anfang oder Ende eines Dokuments), wird mit Leerzeichen aufgefüllt.

Beispiel:

Suchkette=Kinder, Vorkontext=3, Nachkontext=5 liefert das Ergebnis:
{{ei Kindern bis};2,214.967,246.836,243.862,256.086}{{en Kinder unfa};2,202.192,336.836,231.087,346.086}

Die Property PdfSearchResult wird weiterhin zusätzlich belegt.

Get

PdfSearchText

String

Setzen der gesuchten Zeichenkette im Dokument. Hierbei kann es sich auch um eine längere Textpassage handeln.

Set

PdfSearchContext

(ab CIB pdf toolbox 1.4.80)

String

Setzen eines Kontextes für die gesuchte Zeichenkette, der als Suchergebnis mitausgegeben wird.

=“m;n“
m= Anzahl Zeichen vor

n= Anzahl Zeichen nach der gesuchten           Zeichenkette

Wird nur eine Zahl angegeben, so werden die Zeichen nach der gesuchten Zeichenkette verwendet.

Set

PdfVersionInfo

(ab CIB pdf toolbox 1.18.0)

String

Diese Property liefert die PDF-Version und Spezial-Version des Dokuments zurück.
Die Ausgabe erfolgt im JSON Format.

Beispiel:

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

Das PDF-Dokument hat die PDF-Version 1.4  und es erfüllt zusätzlich die Spezifikationen PDF/X und PDF/A.

Get

FirstPage

LastPage
(ab CIB pdf toolbox 1.4.81)

String

Einschränken der Textsuche (PdfSearchText) bzw. der Textausgabe (OutputFormat=FormatText) auf einen Seitenbereich.

Beispiel:

FirstPage=1  LastPage=3

Es wird nur Seite 1 bis 3 bearbeitet.

Wenn die Angabe LastPage fehlt, geht der Bereich bis zum Ende des Dokuments.

Set

PdfSecurityMethod

String

Mögliche Werte sind:

„“ = keine Methode

„Standard“ = Methode ist „adobe standard security“

Get

PngCompressLevel

(ab CIB pdf toolbox 1.4.105)

String

Steuerung des Maßes der Kompression der Grafik beim Speichern.
Die Schreibgeschwindigkeit kann durch Verringern der Kompression (und damit Erhöhen der Dateigröße) erhöht werden. So wird bei Verdoppeln der Dateigröße die Datei fünfmal so schnell geschrieben.

Mögliche Werte:

1          Standard-Wert für PNG Kompression

0          Keine Kompression

9          Maximale Kompression

2          Default

Set

PrefixDelimiter”

(ab CIB pdf toolbox 1.3.62)

String

Der Parameter—prefix-delimiter definiert ein Trennzeichen zwischen Alias und Variablennamen und schaltet den Präfix-Mechanismus fest ein.

Durch Setzen des Parameters—prefix-delimiter werden beim Einsatz von Multiknoten die Variablen eindeutig gehalten.
(identisch zu CIB merge—prefix-delimiter)

Default=leer

Set

PrintCentered

String

Ist die Property auf „1“ gesetzt, wird die Seite(in x- und y-Richtung) bezüglich des bedruckbaren Bereichs(nicht des Papiers) zentriert. (default)

Ist diese Property auf „0“ gesetzt, findet kein Zentrieren statt.

Get/
Set

PrintScaling

String

Skalieroptionen der Seiten auf den Druckbereich:

PrintScaleNone – Die PDF-Seite wird nicht auf Druckerbegrenzungen skaliert. D.h. Texte und Grafiken werden abgeschnitten, wenn sie außerhalb der Druckseitengröße liegen. Die linke obere Ecke der PDF-Seite entspricht der linken oberen Ecke des bedruckbaren Bereichs - nicht des Papiers. Falls die PDF-Seite nicht im gleichen Seitenformat wie das Papier ist, bezieht sich die linke obere Ecke der PDF-Seite auf die gedrehte Druckseite.(default)

PrintScaleDown – größeres Papier wird auf den bedruckbaren Bereich skaliert.

PrintScaleFit – Das Papier wird passend auf den bedruckbaren Bereich skaliert, d.h. größere werden verkleinert und kleinere vergrößert

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

(ab CIB pdf toolbox Version 1.6.116f)

String

„0“: Es wird nichts getan. (default)

„1“: Aktualisiert XMP-Daten im PDF aus den DocInfo Werten.

Set

RenderingEngine

(ab CIB pdf toolbox Version 1.7.0)

(ab CIB pdf toolbox Version 1.14.0)

String

“Internal” – Interne Rendering-Engine wird verwendet (Default für Unix-Systeme)

“WinGDI” – Windows Rendering-Engine wird verwendet (Default für Windows-Systeme)

“CIBRenderer” – Pango-Cairo Rendering-Engine wird verwendet;
(Default für Unix- und Windows-Systeme)

Set

TraceFilename

String

Gibt an, wohin die Logmeldungen der Toolbox ausgegeben werden

Get/
Set

RegionTemplate

String

Über die Property wird der Name der XFDF-Datei übergeben, die die Bereiche (Rechtecke) enthält, aus denen Text extrahiert werden soll. Der extrahierte Text wird in eine XFDF- bzw. CSV-Datei geschrieben.

Voraussetzung:
OutputFormat=FormatXfdfWithAnnots

RegionTemplate=<name>.xfdf

Set

RegionThreshold

String

Die Property gibt den prozentualen Anteil an, ab dem ein Zeichen zur Region gehört. Wenn also ein Zeichen zu einem geringeren Prozentsatz als hier angegeben  in die Region hineinragt, zählt es nicht zur Region.

RegionThreshold=<integer>

Voraussetzung:
OutputFormat=FormatXfdfWithAnnots
und Verwendung von RegionTemplate

Set

SvgImageBounds

(ab CIB pdf toolbox Version 1.20.0)

String

Über diese Property kann die maximale Auflösung (und damit die Größe der Ausgabe des Rendering-Prozesses) für SVG-Grafiken begrenzt werden.

Möglicher Wert:

Ein JSON-String mit folgenden Parametern/Werten:

{

„MinImageHeight“: 50,
// Die minimale Höhe der Eingabe-Grafik, bei der dieser Algorithmus wirksam wird,
default: 50

„MinImageWidth“: 50,
// Die minimale Breite der Eingabe-Grafik, bei der dieser Algorithmus wirksam wird,
default: 50

„ResolutionThresholdJpeg“: 180,
// Schwellenwert, bei dessen Überschreiten die Größe der JPEG-Grafik heruntergerechnet wird. Heruntergerechnet wird auf den Wert aus „MaxResolutionJpeg“ (hier: 150 DPI).

„ResolutionThresholdPng“: 180,
// Schwellenwert, bei dessen Überschreiten die Größe der PNG-Grafik heruntergerechnet wird. Heruntergerechnet wird auf den Wert aus „MaxResolutionPng“ (hier: 150 DPI).

„MaxResolutionJpeg“: 150,
// Bei Überschreiten des Schwellen-wertes aus ResolutionThresholdJpeg wird die JPEG-Grafik auf 150 DPI heruntergerechnet.

„MaxResolutionPng“:  150,
// Bei Überschreiten des Schwellen-wertes aus ResolutionThresholdPng wird die PNG-Grafik auf 150 DPI heruntergerechnet.

}

Set

TempPath

(ab CIB pdf toolbox Version 1.20.0)

String

Der in dieser Property angegebene Pfad wird verwendet für die Ablage von
- temporären Font-Dateien
- die Liste der installierten Fonts
- temporären Postscript-Seiten (bei Prostscript-Druck)

Andere Pfade wie z.B. zum Verzeichnis der Ausgabedatei, werden von dieser Property nicht beeinflusst.

Der Pfad muss auf ein gültiges Verzeichnis verweisen. Es kann sich um einen relativen oder absoluten Pfad handeln.

Set

GraphicLayerInfo

(ab CIB pdf toolbox Version 1.25.0)

String

In dieser Property wird zurückgemeldet, welche Grafiken beim Renderingvorgang im PDF gefunden werden.
Die Ausgabe erfolgt im JSON Format

Erforderlich sind:

OutputFormat=FormatText | FormatWebview | FormatJavaView

RenderingEngine=CIBRenderer.

Die Ausgabe hängt vom Inhalt der Property PageSelection ab:

PageSelection leer: GraphicLayerInfo enthält die Information für das ganze PDF

PageSelection gesetzt: GraphicLayerInfo  enthält die Information für jede ausgewählte Seite

Beispiele:

PageSelection leer:

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

PageSelection gesetzt auf “1-2”:

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

Get

TextLayerInfo

(ab CIB pdf toolbox Version 1.18.0)

String

In dieser Property wird zurückgemeldet, welche Textgruppen beim Renderingvorgang im PDF gefunden werden.
Die Ausgabe erfolgt im JSON Format

Folgende Textgruppen sind möglich:

any_visible – Jeder sichtbare Text

simple_invisible – Unsichtbarer Text, nicht speziell gekennzeichnet

cibocr_invisible – Unsichtbarer Text, von der CIB pdf toolbox als CIB_HOCR gekennzeichnet

others_invisible – Unsichtbarer Text, von anderen PDF-Prozessoren gekennzeichnet

Beispiel:

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

Hinweise:

OutputFormat muss auf
FormatText, FormatWebview oder FormatJavaView bzw. muss bei Grafikformaten RenderingEngine=CIBRenderer gesetzt sein.

Die PageSelection Property beeinflusst das Ausgabeformat der Property TextLayerInfo.

Keine PageSelection gesetzt: TextLayerInfo enthält die zusammengesetzte Information über das ganze Dokument.

PageSelection ist gesetzt:
TextLayerInfo enthält die Information einzeln pro ausgewählte Seite.

Beispiele:

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

PageSelection ist gesetzt auf 1-3,
Seite 1 enthält nur sichtbaren Text,
Seite 2 enthält sichtbaren und simple invisible Text
Seite 3 enthält gar keinen Text:
{“groups“: [[“any_visible“],[“any_visible“,“simple_invisible“],[]]}

Get

TextMark

(ab CIB pdf toolbox Version 1.37.0)

String

Die Eigenschaft funktioniert nur für das Ausgabeformat FormatText und arbeitet in Verbindung mit TextSelectionFilter.

Wenn der Wert von TextSelectionFilter gesetzt ist als: TextSelectionFilter={"groups":["marked_invisible"]}

Dann gibt die CIB pdf toolbox nur unsichtbaren Text aus, der mit einem speziellen Tag markiert ist, der durch die Eigenschaft TextMark angegeben wird.

Für andere Gruppen im TextSelection-Filter wird die Eigenschaft TextMark ignoriert.

Die CIB pdf toolbox extrahiert Text, der im pdf-Inhaltsstrom mit einem speziellen Tag markiert ist: CIB_HOCRerty. TextMark wird ignoriert.

Beispiel:

CibRsh.exe OutputFormat=FormatText TextSelectionFilter=

{"Gruppen":["marked_invisible"]}

TextMark=CIB_HOCR -fj Eingabe.pdf Ausgabe.txt

Get

TextOutput

(ab CIB pdf toolbox Version 1.37.0)

String

Wenn wir FillTextOutput=1 setzen, dann wird die Ausgabeeigenschaft TextOutput mit Text in Utf8-Kodierung gefüllt.

Get

TextSelectionFilter

(ab CIB pdf toolbox Version 1.18.0)

String

Über TextSelectionFilter kann die Property IncludeInvisibleText konfiguriert warden, d.h. sie steuert im Detail, welche Arten von sichtbaren und unsichtbaren Texten ausgegeben werden.
Sie hat JSON Format und wenn sie gesetzt ist, übersteuert sie die Angaben aus IncludeInvisibleText.

Als Auswahl können zusätzlich zu den einfachen Textgruppen any_visible,  simple_invisible, cibocr_invisible,  others_invisible (Details siehe Property TextLayerInfo) auch zusammengesetzte Textgruppen verwendet werden:

any_invisible – jeder unsichtbare Text (simple_invisible + cibocr_invisible + others_invisible)

any – jeder Text (any_visible + any_invisible)

Hinweise:

Die Property beeinflusst nur Ausgabe in Text- und Metafiles.

Sie ist nur gültig für OutputFormat
FormatText, FormatWebview, FormatJavaView, FormatView.

Beispiele:

TextSelectionFilter={“groups“:[“cibocr_invisible“]}
Nur Texte der Textgruppe cibocr_invisible werden ausgegeben (falls vorhanden)

TextSelectionFilter={”groups”:[”any_visible”, “any_invisible”]}
Alle Textgruppen werden ausgegeben

Set

UseColorProfileForCMYK

(ab CIB pdf toolbox Version 1.4.98)

String

Mögliche Werte für Umwandlung in RGB:

„1“       „US Web coated“ und „sRGB“ Profile werden benutzt (default)

„0“       einfache Variante

Set

UseJbig2Compression

(ab CIB pdf toolbox Version 1.10.0)

String

Achtung: Nur für Grafik-Overlay

Über diese Property kann die für Overlay-Grafiken standardmäßig aktivierte Jbig2-Kompression deaktiviert werden.

0          Jbig2-Kompression wird deaktiviert, Der Standard ZLIB Kompression wird angewendet. 

1          Jbig2-Kompression wird aktiviert (default)

Hinweis:
Jbig2-Kompression wird nicht angewendet bei
1) JPG Grafiken
2) Grafiken mit mehr als 2 Farben.

Set

UseWinGDI

String

Wird nicht mehr verwendet,
abgelöst von RenderingEngine=WinGDI

„1“ = Windows Rendering-Engine wird verwendet (Default für Windows-Systeme)

„0“ = Interne Rendering-Engine wird verwendet (Default für Unix-Systeme)

Set

UseSvgExternalImages

(ab CIB pdf toolbox Version 1.17.0)

Ermöglicht es, alle internen Bilder, die zu SVG Grafiken zusammengefasst sind, separat vom SVG Inhalt als externe Resourcen zu speichern (JPEG oder PNG).

Mögliche Werte:

0          deaktiviert

1          aktiviert

ViewCallback

String

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

Get/
Set

WorkSpace

(ab CIB pdf toolbox Version 1.4.81):

(ab CIB pdf toolbox Version 1.4.84):

String

Definitiert das Arbeitsverzeichnis für alle Dateinamensangaben, ausgenommen Ausgabedateien.

Der Pfad wird als nullterminierte Zeichen­kette angegeben. Der Pfad kann absolut angegeben werden oder relativ zum Arbeits­verzeichnis des aufrufenden Prozesses.

Alle Dateiangaben (ohne absoluten Pfad) in Properties werden relativ zu diesem Work­space betrachtet.

Es kann auch eine Liste von Arbeits­ver­zeich­nissen angegeben werden. Die ein­zelnen Angaben werden durch Semi­kolon getrennt. Für jede verwendete Datei wird eine Suche gestartet und die erste Fund­stelle genutzt.

Ab dieser Version gilt die Property WorkSpace nicht mehr für Ausgabedateien.

Get/
Set

PageXmpMetadata

(ab CIB pdf toolbox Version 1.14.0):

String

Diese Property dient dem Hinzufügen bzw. Überschreiben von Seiten-bezogenen Metadaten in einem PDF. Sie werden auf der jeweiligen Seite über “/Metadata“ referenziert.

Syntax:
Die Syntax für die Seitenangabe ist identisch zu der von Property „InputFilename”, nur “Leerseite” wird hier nicht benötigt.

Für jede Seite bzw. Seitenbereich des Ausgabe-PDFs können Metadaten (UTF-8 kodiert) spezifiziert werden. Die Metadaten können als XML-Datei oder Speicherblock übergeben werden.

Wenn eine Seite bereits Metadaten enthält, so werden diese durch die neuen Daten ersetzt. Sind nur einige Seiten eines Dokuments angesprochen, bleiben Metadaten der restlichen Seiten unverändert erhalten.

Beispiele:

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

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

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

Set

XMPMetadataExtension

String

Erlaubt die Angabe eines oder mehrerer XMP-Snippets vom Typ rdf:Description. Diese werden beim Konvertierungsvorgang (CibPdfSave()) der Metainfo des entstehenden PDFs hinzugefügt.

Bitte beachten Sie dabei die offizielle XMP Spezifikation von Adobe.

Set

XfdfIgnorePageRotation

(ab CIB pdf toolbox Version 1.17.0):

String

0 (default): Koordinaten werden im Seitenkoordinatensystem interpretiert und abhängig von Seitenausrichtung und cropping. (0,0) ist der Ursprung der MediaBox der Seite.

1: Koordinaten werden relativ zur sichtbaren Seite interpretiert. (0,0) ist die Koordinate Links Unten auf der sichtbaren seite (Nach zuschneiden und drehen)

Set

XfdfFlipPositionY

ab CIB pdf toolbox Version 1.24.0):

String

Über diese Property wird der Ausgangspunkt / Anker der Koordinaten von links unten nach links oben geändert.

0 (default): Ausgangspunkt / Anker der Koordinaten  links unten

1: Ausgangspunkt / Anker der Koordinaten  links oben

Set