CIB pdf toolbox technischer Leitfaden (DE)

CIB pdf toolbox

CibPdf32(64).dll

CibPdf32(64).lib

CibPdf32(64).h

CibDataCsv(64).dll

CibDataXml(64).dll

CIBxalan(64).dll

Xalan-C_1_5_0.dll

xerces-c_2_2_0.dll

cibjbig232(64).dll

libcibpdfux(64).so

libcibpdfux(64).sl

CIB pdf toolbox-DLL für Win, Schnittstelle zur Anwendung

Library zur CIB pdf toolbox

Include Datei zur CIB pdf toolbox

Zugriffs Dll für CSV Daten

Zugriffs Dll für XML Daten

Tool Dll für XML

Tool Dll XML

Tool Dll XML

Tool Dll für JBIG2-Grafiken

CIB pdf toolbox shared library für diverse Unix Systeme

CIB pdf toolbox shared library für HP Unix Systeme

Abhängige Libraries unter Linux/Unix

libgcc_s.so

libstdc++.so.6

Abhängige Libraries unter AIX

libgcc_s.a

libstdc++.a

FlattenFormfields

String

Ist diese Property gleich „1“ gesetzt, so werden die Formularfelder entfernt, aber die optische „Ansicht“ dieser Formularfelder bleibt erhalten.

Mögliche Werte:

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

„1“: Alle Formularfelder werden entfernt, aber die optische „Ansicht“ dieser Formularfelder bleibt erhalten.
Allerdings bleiben nur Formularfelder sichtbar, die auch auf dem Bildschirm sichtbar sind. Ist z.B. ein Formularfeld nur beim Ausdrucken sichtbar, so ist es nach dem Aufruf von FlattenFormfields nicht sichtbar.
Außerdem sind auch alle optischen Effekte, die durch JavaScript bewirkt werden, nicht sichtbar. Die Ansicht nach dem Aufruf von FlattenFormfields ist die gleiche wie bei einem Pdf Reader, bei dem „JavaScript“ deaktiviert ist.
Bei OutputFormat=FormatText wird der Inhalt der Formularfelder in den Textoutput geschrieben.

Set

PdfAFallback

(ab CIB pdf toolbox 1.12.0)

String

Steuert, ob bei Auftreten eines Fehlers bei der PDF/A Konvertierung automatisch die betreffende Seite über CIB renderer als Grafik konvertiert wird.

Mögliche Werte:

„0“   Bei einem Fehler während der PDF/A Konvertierung wird ein Rückgabewert gesetzt(default).

„1“   Bei einem Fehler wird die entsprechende Seite über den CIB renderer als Grafik konvertiert.

Set

PdfVersion

String

Setzen der zu erzeugenden PDF/A Version.

Gültige Werte:

„PDF/A-1b“                  Nach ISO 19005-1

„PDF/A-2b“                  Nach ISO 19005-2

„PDF/A-3b“                  Nach ISO 19005-3

Get/Set

SkipPageXmpCheck

(ab CIB pdf toolbox 1.20.0)

String

Über diese Property kann die Behandlung der auf Seiten-Ebene im PDF vorhandenen XMP Metadaten bei der PDF/A-Konvertierung gesteuert werden.

Mögliche Werte:

0       Default
Alle im PDF vorhandenen XMP Metadaten werden entfernt und in der PDF/A-Ausgabe auf Dokument-Ebene durch XMP-Metadaten mit Standardwerten ersetzt.

1       Die auf Seiten-Ebene vorhandenen XMP Metadaten werden ungeprüft in die PDF/A-Ausgabe übernommen.
In diesem Fall ist der Anwender dafür verantwortlich, dass diese Daten PDF/A konform sind.

Set

ImagePdfCreationPreserveText

(ab CIB pdf toolbox 1.21.0)

String

Über diese Property kann gesteuert werden, dass im Falle eines PDF/A-Fallbacks (PdfAFallback=1, Details siehe Beschreibung zur Property PdfAFallback) extrahiert und in das erzeugte PDF/A eingebettet wird.

Der Textinhalt wird aus dem PDF extrahiert, in das HOCR-Format konvertiert und als HOCR in das PDF/A eingebettet.

Mögliche Werte:

0          Default
Keine Textextraktion

1          Der Textinhalt wird extrahiert und in das PDF/A eingebettet

Set

SignPdf

String

Property, mit der das Signieren des Ausgabe-PDFs eingeschaltet werden kann.

Mögliche Werte:

„0“       kein Signieren (default)

„1“       PDF wird signiert

Eventuell in den Eingabe-PDFs enthaltene Signaturen werden standardmäßig gelöscht.
Falls SignPdf=1, muss NeedAppearances=0 gesetzt werden. (Es wird dann im Pdf Dokument das Feld „/NeedAppearances“ „false“ gesetzt.) Sonst ist die erzeugte Signatur im Adobe Signatur Fenster nicht sichtbar.

Set

SignPdf.DocMDP

String

Die Signatur bekommt den Typ „DocMDP“ (Autorensignatur).

Das bedeutet, dass im PDF nachträglich nur Änderungen vorgenommen werden dürfen, die vom Autor explizit erlaubt wurden. Andere Änderungen machen die Signatur ungültig.
Voraussetzungen: SignPdf=1 und die Pdf Version der Ausgabe-Pdf-Datei ist größer gleich 1.5.

Mögliche Werte:

„“    Keine DocMDP Signatur (default)

„1“   Keine Änderungen erlaubt

„2“   Erlaubt sind:
Ausfüllen von Formularfeldern Erzeugen neuer Seiten aus Seiten-Schablonen
Signieren

„3“   Erlaubt sind:
wie “2”,
zusätzlich: alle Änderungen in Kommentaren

sonst: keine DocMDP Signatur

Hinweis: Dokumente mit DocMDP-Signatur können nur von Adobe Reader 7.0 oder höher gelesen werden.

Set

SignPdf.Lock

String

Die Signatur bekommt den Typ Lock. D.h. es sind keinerlei Änderungen an Formularfeldern erlaubt bzw. es dürfen keine sichtbaren Signaturen mehr hinzugefügt werden.

Voraussetzungen: SignPdf=1, SignPdf.DocMDP ist nicht gesetzt, und die Pdf Version der Ausgabe-Pdf-Datei ist größer gleich 1.5.

Mögliche Werte:

„0“   Keine Sperrung des Dokuments (default)

„1“   Dokument ist im obigen Sinne gesperrt. Dies entspricht der Option „Lock Document After Signing“ von Adobe Professional. Im Adobe Reader wird angezeigt:”The document is locked by that signature”.

Set

CertificateFilename

String

Angabe des Namens (ggf. mit Pfad) der Zertifikats-Datei. Dabei muss es sich um ein PKCS12-Zertifikatsfile handeln (übliche Endung „.p12“ oder „.pfx“).

Die Signierung mit PEM-Datei(en) ist noch nicht verfügbar. Sie ist noch nicht hinreichend getestet. Es können mehrere PEM-Dateien angegeben werden. Diese müssen durch einen Strichpunkt (;) getrennt sein. Alle Dateien zusammen müssen genau einen privaten Schlüssel enthalten. Außerdem muss der öffentliche Schlüssel und (optional) die Schlüsselkette des Signierers enthalten sein. Wenn die PEM-Dateien mehrere private Schlüssel enthalten, wird der erste private Schlüssel verwendet, der zum „CerticatePassword“ passt.

Set

CertificatePassword

String

Angabe des Passwortes für die Zertifikatsdatei.

Set

RemovePdfSignatures

String

Über diese Property wird gesteuert, ob in den Eingabedateien vorhandene Signaturen gelöscht werden oder nicht.

Mögliche Werte:

„0“     Es werden keine Signaturen entfernt.

„1“     Es werden alle Signaturen entfernt.

Es gibt ein unterschiedliches Standard-Verhalten:
Beim Signieren (SignPdf=1), ist standardmäßig RemovePdfSignatures=“1”
Ansonsten (und damit auch beim Verifizieren, CheckPdfSignatures=1) ist standardmäßig RemovePdfSignatures=“0”.

Set

RemovePdfSignaturesKeepAppearance

String

Diese Property wird nur angewendet, wenn entweder RemovePdfSignatures=1 oder SignPdf=1 gesetzt sind.

Mögliche Werte:

„0“     Beim Entfernen der Signaturen wird auch der sichtbare Teil der Signatur entfernt. (default)

„1“     Beim Entfernen der Signaturen wird der sichtbare Teil der Signatur (z.B. ein Bild oder ein Text) beibehalten. Die Signatur selbst wird aber entfernt.

Set

CheckPdfSignatures

String

Über diese Property wird gesteuert, ob in den Eingabedateien vorhandene Signaturen geprüft werden oder nicht.

Mögliche Werte:

„0“     Es werden keine Signaturen geprüft. (default)

„1“       Es werden alle Signaturen geprüft.

Set

TrustedCertificatesDirectory

String

Verzeichnis, das die vertrauenswürdigen Zertifikate (mit den öffentlichen Schlüsseln) für die CIB pdf toolbox enthält.

Zum Überprüfen der Vertrauenswürdigkeit der Signatur-Zertifikate im Pdf Dokument bei CheckPdfSignature=”1” ist dieses Verzeichnis zwingend erforderlich.

Default: ””.

Falls diese Eigenschaft leer ist, kann nicht überprüft werden, ob die Signatur-Zertifikate vertrauenswürdig sind. Aber die Verifizierung der Signatur wird trotzdem nicht abgebrochen!

Folgende Zertifikatsfiles mit öffentlichen Schlüsseln werden unterstützt:

            CER-files („.cer“) in DER- und Base64-Codierung

            CRT-files („.crt“) in DER- und Base64-Codierung

            PEM-files („.pem“)

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

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

            SPC-files („.spc“) in DER-Codierung
Dateien mit anderen Endungen werden ignoriert.
Die Zertifikatsdateien sollten nur öffentliche Schlüssel enthalten.

Set

OutputFormat

String

Das Prüfverhalten (also nur bei CheckPdfSignature=”1”) der CIB pdf toolbox wird durch die Belegung der Property “OutputFormat” gesteuert. Dafür wurde ein neuer Wert ”FormatAnalyse” eingeführt.

-      OutputFormat=”FormatAnalyse”
Der Prüf-Prozess 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.
 

-      OutputFormat ungleich“FormatAnalyse”
Sobald die Signatur einer Eingabedatei nicht gültig ist, wird die Verarbeitung mit Fehler abgebrochen und damit keine der SignedDocument.xxx-Properties gesetzt.
Nur bei erfolgreichem Durchlauf werden die SignedDocument.xxx-Properties gesetzt.

Set

SignedDocument.DocumentIsUnmodified

String

Für jedes Eingabe-PDF wird der Änderungsstatus ausgegeben.
(Nur relevant für OutputFormat=“FormatAnalyse“ und CheckPdfSignatures=”1”)

Für jede Eingabedatei wird in Form einer Liste, durch „;“ getrennt, je ein Wert ausgegeben.
Z.B.: „1;0;no signature“.

Mögliche Werte:

“”    Nicht belegt durch die CIB pdf toolbox.   (default)

“1”   Das Dokument wurde nach dem Signieren nicht mehr geändert.

“0”   Das Dokument wurde nach dem Signieren geändert.

“not implemented”  Diese Funktionalität wurde noch nicht implementiert.

“no signature”  Das PDF enthält keine Signatur.

Get

SignedDocument.DocumentModificationsAreAllowed

String

Für jedes Eingabe-PDF werden eventuell erfolgte Änderungen klassifiziert.
(Nur relevant für OutputFormat=“FormatAnalyse“ und CheckPdfSignatures=”1”)

Für jede Eingabedatei wird in Form einer Liste, durch „;“ getrennt, je ein Wert ausgegeben.
Z.B.: „1;0;no signature“.

Achtung:
Diese Property ist noch nicht vollständig implementiert, daher kann häufig der Wert „not implemented“ auftreten.

Mögliche Werte:

“”    Nicht belegt durch die CIB pdf toolbox.   (default)

“1”   Die nach dem Signieren erfolgten Änderungen sind erlaubt.

“0”   Die nach dem Signieren erfolgten Änderungen sind nicht erlaubt.

“not implemented”    Diese Funktionalität wurde noch nicht implementiert.

“no signature”   Das PDF enthält keine Signatur.

Get

SignedDocument.DocumentSignatureDateIsValid

String

Für jedes Eingabe-PDF wird das Signaturdatum geprüft.
(Nur relevant für OutputFormat=“FormatAnalyse“ und CheckPdfSignatures=”1”)

Für jede Eingabedatei wird in Form einer Liste, durch „;“ getrennt, je ein Wert ausgegeben.
Z.B.: „1;0;no signature“.

Mögliche Werte:

“”    Nicht belegt durch die CIB pdf toolbox.   (default)

“1”   Das Signaturdatum im PDF passt zu allen Datumsangaben in der Zertifikatskette.

“0”   Das Signaturdatum fehlt, oder es passt nicht zu mindestens einem Datum aus der Zertifikatskette.

“not implemented”    Diese Funktionalität wurde noch nicht implementiert.

“no signature”   Das PDF enthält keine Signatur.

Get

SignedDocument.CertificateChainIsValid

String

Für jedes Eingabe-PDF wird geprüft, ob die Zertifikatskette durchgängig gültig ist.
(Nur relevant für OutputFormat=“FormatAnalyse“ und CheckPdfSignatures=”1”)

Für jede Eingabedatei wird in Form einer Liste, durch „;“ getrennt, je ein Wert ausgegeben.
Z.B.: „1;0;no signature“.

Mögliche Werte:

“ ”   Nicht belegt durch die CIB pdf toolbox.   (default)

“1”   Die Zertifikatskette ist durchgängig gültig.

“0”   Mindestens ein Zertifikat in der Zertifikatskette ist nicht gültig.

“not implemented”    Diese Funktionalität wurde noch nicht implementiert.

“no signature”   Das PDF enthält keine Signatur.

Get

SignedDocument.CertificateIsTrusted

String

Für jedes Eingabe-PDF wird die Vertrauenswürdigkeit der Signaturen überprüft.
(Nur relevant für OutputFormat=“FormatAnalyse“ und CheckPdfSignatures=”1”)

Für jede Eingabedatei wird in Form einer Liste, durch „;“ getrennt, je ein Wert ausgegeben.
Z.B.: „1;0;no signature“.

Mögliche Werte:

“ ”   Nicht belegt durch die CIB pdf toolbox.   (default)

“1”   Ein Zertifikat aus der Zertifikatskette ist gültig. Und die Kette vom Zertifikat der Signatur bis zu diesem gültigen Zertifikat ist durchgängig gültig.

“0”   Es gibt kein gültiges Zertifikat in der Zertifikatskette. Oder die Kette vom Zertifikat der Signatur bis zu dem gültigen Zertifikat ist nicht durchgängig gültig.

“not implemented”    Die Property “TrustedCertificatesDirectory” ist nicht belegt.

“no signature”   Das PDF enthält keine Signatur.

Get

Angehängte Datei hat kein Passwort

Angehängte Datei hat ein Eigentümer-Passwort

Angehängte Datei hat ein Eigentümer- und ein Benutzer-Passwort

Hauptdatei hat kein Passwort

Ergebnisdatei hat kein Passwort.

Ergebnisdatei hat das Passwort der angehängten Datei.

Ergebnisdatei hat hat das Passwort der angehängten Datei..

Hauptdatei hat ein Eigentümer-Passwort

Ergebnisdatei hat Eigentümer-Passwort der Hauptdatei.

Ergebnisdatei hat Eigentümer-Passwort der Hauptdatei.

Ergebnisdatei hat Eigentümerpasswort der Hauptdatei.

Hauptdatei hat ein Eigentümer- und Benutzer-Passwort

Ergebnisdatei hat Eigentümer- und Benutzer-Passwort der Hauptdatei.

Ergebnisdatei hat Eigentümer- und Benutzer-Passwort der Hauptdatei.

Ergebnisdatei hat Eigentümer- und Benutzer-Passwort der Hauptdatei.

AllowPdfPermissions

(ab CIB pdf toolbox 1.8.3)

String

Über die Property kann gesteuert werden, ob bei der Verarbeitung die im PDF über das Owner-Passwort gesetzten Bearbeitungsrechte berücksichtigt werden.

Achtung:
Ein evtl. im PDF vergebenes User-Passwort muss gesetzt werden, sonst findet keine Verarbeitung statt.

Das erzeugte Ausgabe-PDF ist nicht verschlüsselt.

1          Rechte werden ignoriert

0          Rechte werden beachtet (default)

Bei der PDF/A Konvertierung eines mit Ownerpasswort geschützten PDF muss diese Property auf den Wert „1“ gesetzt werden. Andernfalls wird ein Fehler ausgegeben.

Set

EncryptDocumentPassword

(ab CIB pdf toolbox 1.18.0)

String

Über diese Property kann das Passwort für ein Passwort-geschütztes Dokument übergeben werden ohne die Detailangabe, ob es sich um ein EncryptUserPassword oder EncryptOwnerPassword handelt.

Die Syntax ist identisch zu der von diesen beiden Properties.

Wenn das EncryptDocumentPassword gesetzt wird, stellt die CIB pdf toolbox bei der Verarbeitung fest um welches Passwort es sich dabei handelt (User oder Owner).

Für die Rückmeldung dieser Information wurden die Metadaten PDFPERMISSION (= SECURITYINFO) um das Flag IsOwnerAccess erweitert:
1          Owner-Passwort
0          User-Passwort

Achtung:
Die SECURITYINFO Metadaten werden nur bei verschlüsselten Dokumenten gesetzt. Falls sie aldso nicht vohanden sind bedeutet das, dass das Dokument ungeschützt ist.

Set

EncryptOwnerPassword

String

Owner-Passwort (Eigentümer-Passwort) der Eingabedatei (bzw. der Eingabe­dateien) bzw. BackgroundFilename.
Die Passwörter sind in genau der Reihenfolge aufzulisten wie die zugehörigen Dateien innerhalb der Properties InputFilename /BackgroundFilename (durch „;“ getrennt).

Das Passwort selbst darf kein „;“ enthalten.

Set

EncryptUserPassword

String

User-Passwort (Benutzer-Passwort) der Eingabedatei (bzw. der Eingabe­dateien) bzw. BackgroundFilename.
Die Passwörter sind in genau der Reihenfolge aufzulisten wie die zugehörigen Dateien innerhalb der Properties InputFilename /BackgroundFilename (durch „;“ getrennt).

Das Passwort selbst darf kein „;“ enthalten.

Set

OutputOwnerPassword

String

Vergibt neues Owner-Passwort (Eigentümer-Passwort) für die Ausgabedatei.

Das Passwort selbst darf kein „;“ enthalten.

Set

OutputUserPassword

String

Vergibt neues User-Passwort (Benutzer-Passwort)  für die Ausgabedatei.

Das Passwort selbst darf kein „;“ enthalten.

Set

PdfUserPasswordPresent
(ab CIB pdf toolbox 1.4.78)

String

Mögliche Werte sind:

„“ oder „0“ = es ist kein User-Password vorhanden

“1” = User-Password ist vorhanden

Get

PdfOwnerPasswordPresent
(ab CIB pdf toolbox 1.4.78)

String

Mögliche Werte sind:

„“ oder „0“ = es ist kein Owner-Password vorhanden

“1” = Owner-Password ist vorhanden

Get

PdfVersion

String

Setzen der zu erzeugenden PdfVersion.

Gültige Werte:

“1.3”                Acrobat-Familie 4

“1.4”                Acrobat-Familie 5 (default)

“1.5”                Acrobat-Familie 6

“1.6”                Acrobat-Familie 7

„1.7“                Acrobat-Familie 8

Ab CIB pdf toolbox Version 1.4.109:
“1.7EL3“           Acrobat Familie 8
            (zum Öffnen ist ein Acrobat                 Reader ab Version 9 erforderlich!)

Hinweis:
Bei aktivierter Verschlüsselung werden folgende Verschlüsselungs-Algorithmen angewendet:
”1.3”                RC4-40, Revision 2
”1.4”                RC4-128, Revision 3
”1.5”                RC4-128, Revision 4
ab “1.6”            AES-128, Revision 4
ab „1.7EL3“      AES-256, Revision 5

Get/
Set

EncryptMetadata

(Ab CIB pdf toolbox Version 1.4.109)

String

Durch Setzen dieser Property kann der Benutzer steuern, ob die Metadaten im PDF verschlüsselt werden.
Bei den Metadaten handelt es sich um allgemeine Informationen zum PDF wie Autor, Erstellungsdatum etc. Format und Inhalt der Metadaten sind nicht festgelegt und hängen von dem Tool ab, das das PDF erstellt hat.

Mögliche Werte:
„0“       keine Verschlüsselung der Meta-
            daten
„1“       Metadaten werden verschlüsselt
            (default)

Hinweis:
Für die Verarbeitung dieser Property ist eine PdfVersion von mindestens 1.5 erforderlich.

Get/
Set

Die Einstellungen der folgenden Encryptxxx-Properties (Berechtigungen) werden generell mit dem Passwort aus der Eingabe in das Ausgabedokument übernommen. Siehe hierzu Kapitel „Wie verhält sich die CIB pdf toolbox bei Passwortschutz?“.
Bei unverschlüsselter Eingabe werden in der Ausgabe alle Schalter auf TRUE gesetzt.

Wird für das Ausgabedokument ein neues Passwort (OutputOwnerPassword, OutputUserPassword) vergeben, können die Berechtigungen durch Setzen der folgenden Encryptxxx-Properties neu vergeben werden.

EncryptEnableAssembling

String

Dokumentzusammenstellung für die Ausgabedatei genehmigen.

Mögliche Werte:
“1“ oder „TRUE“            erlaubt
“0“ oder „FALSE“          nicht erlaubt  

Set

EncryptEnableClipboard

String

Kopieren von Inhalt für die Ausgabedatei genehmigen.

Mögliche Werte:
“1“ oder „TRUE“            erlaubt
“0“ oder „FALSE“          nicht erlaubt

Set

EncryptEnableExtract

String

ScreenReader-Programme (z.B. für Sehbehinderte) können auf den Inhalt zugreifen. Der Benutzer darf Text und Grafiken nicht aus der PDF-Datei kopieren, wenn dieser Wert gesetzt ist.

Mögliche Werte:

„0“       keine Erlaubnis (default)

„1“       Aktion erlaubt

Set

EncryptEnableForms

String

Ausfüllen von Formularfeldern für die Ausgabedatei genehmigen.

Mögliche Werte:
“1“ oder „TRUE“            erlaubt
“0“ oder „FALSE“          nicht erlaubt

Set

EncryptEnableModifying

String

Der Benutzer darf die PDF-Datei verändern (Text hinzufügen etc.), wenn dieser Wert gesetzt ist.

Mögliche Werte:

„0“       keine Erlaubnis (default)

„1“       Aktion erlaubt

Set

EncryptEnableNotes

String

Der Benutzer darf der PDF-Datei Text Notes und AcroForm Felder hinzufügen und vorhandene ändern, wenn dieser Wert gesetzt ist.

Mögliche Werte:

„0“       keine Erlaubnis (default)

„1“       Aktion erlaubt

Set

EncryptEnablePrinting

String

Drucken für die Ausgabedatei genehmigen.

Mögliche Werte:
“1“ oder „TRUE“            erlaubt
“0“ oder „FALSE“          nicht erlaubt

Set

PdfEncryptionLevel
(ab CIB pdf toolbox 1.4.78)

String

Liefert die Verschlüsselungstiefe, welche größer gleich 40 und immer ein Vielfaches von 8.

Get

PdfEncryptionAlgorithm
(ab CIB pdf toolbox 1.4.78)

String

Liefert den Wert des Verschlüsselungsalgorithmus.

„0“ = undokumentierter Algorithmus

„1“ = PDF-Verschlüsselung 40 bit (RC4-40)

„2“ = PDF-Verschlüsselung, 40 bit oder höher (RC4-128)

„3“ = undokumentierter Algorithmus

Ab CIB pdf toolbox 1.4.107:

„4“ = AES-128

Ab CIB pdf toolbox 1.4.109:

„5“ = AES-256

Bei den Fällen „4“ und „5“ ist benutzerdefinierte Verschlüsselung möglich. Hiermit ist das von Acrobat angebotene Feature „Metadaten unverschlüsselt“ gemeint.

Get

PdfPermissionAssemble
(ab CIB pdf toolbox 1.4.78)

String

Mögliche Werte sind:

„“ = Tauschen von Seiten, erzeugen von Lesezeichen und Thumbnails erlaubt

„NotAllowed” = Tauschen von Seiten, erzeugen von Lesezeichen und Thumbnails nicht erlaubt

Get

PdfPermissionContentAccess
(ab CIB pdf toolbox 1.4.78)

String

Mögliche Werte sind:

„“ = ausschneiden von Text und Grafik erlaubt

„NotAllowed” = ausschneiden von Text und Grafik nicht erlaubt

Get

PdfPermissionCopy
(ab CIB pdf toolbox 1.4.78)

String

Mögliche Werte sind:

„“ = kopieren von Text und Grafiken erlaubt

„NotAllowed“ = kopieren von Text und Grafiken nicht erlaubt

Get

PdfPermissionFillFormFields
(ab CIB pdf toolbox 1.4.78)

String

Mögliche Werte sind:

„“ = ausfüllen von Formularfeldern, einschließlich Signaturfeldern, erlaubt

„NotAllowed“ = ausfüllen von Formularfeldern, einschließlich Signaturfeldern, nicht erlaubt

Get

PdfPermissionModify

(ab CIB pdf toolbox 1.4.78)

String

Mögliche Werte sind:

„“ = Änderung ist erlaubt
(bit 3 gesetzt oder Dokument nicht verschlüsselt)

„NotAllowed“ = nicht erlaubt
(bit 3 nicht gesetzt)

Get

PdfPermissionModifyAnnotations

(ab CIB pdf toolbox 1.4.78)

String

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

Mögliche Werte sind:

„“ = Änderung von Annotations ist erlaubt
(bit 5 gesetzt oder Dokument nicht verschlüsselt)

„NotAllowed“ = nicht erlaubt
(bit 5 nicht gesetzt)

Get

PdfPermissionPrint
(ab CIB pdf toolbox 1.4.78)

String

Mögliche Werte sind:

„“ = Drucken erlaubt

„NotAllowed“ = Druck nicht erlaubt

„Low Resolution“ = Druck nur in geringer Auflösung

Get

PdfPermissions

String

Bitfeld als Dezimalzahl, erlaubte Zugriffsarten ohne Hauptkennwort

Get

OutlinesDeleteExisting

String

Über diese Property kann man alle Outlines und Bookmarks aus den Eingabe Dokumenten entfernen.

Mögliche Werte:

„0“: Die vorhandenen Outlines werden nicht entfernt. (default)

„1“: Alle vorhandenen Outlines werden entfernt.

Set

OutlinesAdd

String

Über diese Property kann man neue Outlines und Bookmarks in das Ausgabe Pdf Dokument einfügen. Falls schon Bookmarks vorhanden sind und erhalten bleiben sollen (d.h. OutlinesDeleteExisting=0), werden die neuen Bookmarks an die vorhandenen angefügt. Mögliche Werte:

„ “: Es werden keine Outlines hinzugefügt. (default)

Ein nicht leerer String: Es werden die Outlines, die in dieser Property angegeben werden, in das Ausgabe-PDF eingefügt.
Bei falscher Syntax: Fehlercode 349 (CIBPDF_ERROR_OUTLINES_ADD_WRONG_FORMAT)
 

Syntax:

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

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

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

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

<page> ::= <Integer>

<outlinetext> ::= <Text>

<outlinedescendants> ::= <outlinelist>

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

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

<Fit> ::= “Fit”

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

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

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

<FitB> ::= „FitB“

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

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

Details und Beispiele siehe nächste Abschnitte.

Set

(Ab CIB pdf toolbox 1.10.0 )

Property liefert einen String mit identischer Struktur zurück.

Get

XYZ

XYZ;Zahl1;Zahl2;
Zahl3

Die angegebene Seite wird so angezeigt, dass die x-y-Koordinate (Zahl1;Zahl2) der Seite sich am linken oberen Rand des Fensters befindet. Zahl3 ist der Zoomfaktor für die Seite (Zahl3=1 ist z.B. ein Zoom von 100%, Zahl3=2 ein Zoom von 200%, usw.). Speziell Zahl3=0 bedeutet, dass der aktuelle Zoomfaktor unverändert bleibt.

Fit

Fit

Die angegebene Seite wird so stark vergrößert, dass die Seite das Fenster exakt ausfüllt. Ist das nicht exakt möglich, so wird die Seite so vergrößert, dass die Seite auf jeden Fall vollständig im Fenster sichtbar ist. Eine Dimension der Seite füllt dann exakt das Fenster aus. Die andere Dimension der Seite ist dann kleiner als das Fenster und ist innerhalb des Fensters mittig zentiert.

FitH

FitH;Zahl1

Die angegeben Seite wird so angezeigt, dass die y-Koordinate Zahl1 der Seite genau am oberen Ende des Fensters angezeigt wird. Gleichzeitig wird die Seite genau so weit vergrößert, dass die Seite in der Breite das Fenster exakt ausfüllt.

FitV

FitV;Zahl1

Die angegeben Seite wird so angezeigt, dass die x-Koordinate Zahl1 der Seite genau am linken Rand des Fensters angezeigt wird. Gleichzeitig wird die Seite genau so weit vergrößert, dass die Seite in der Höhe das Fenster exakt ausfüllt.

FitR

FitR;Zahl1;Zahl2;
Zahl3;Zahl4

Die Werte (Zahl1;Zahl2;Zahl3;Zahl4) sind die Koordinaten eines Rechtecks innerhalb der Seite in der Darstellung (x-Wert-Links;y-Wert-Unten;x-Wert-Rechts;y-Wert-Oben). Die Seite wird genau so angezeigt und vergrößert, dass dieses Rechteck das Fenster exakt ausfüllt. Ist das nicht exakt möglich, so wird die Seite so vergrößert, dass das Rechteck auf jeden Fall vollständig im Fenster sichtbar ist. Eine Dimension des Rechtecks füllt dann exakt das Fenster aus. Die andere Dimension des Rechtecks ist dann kleiner als das Fenster und ist innerhalb des Fensters mittig zentiert.

FitB

FitB

Die angegebene Seite wird so stark vergrößert, dass der Begrenzungsrahmen (BoundingBox) der Seite das Fenster exakt ausfüllt. Ist das nicht exakt möglich, so wird die Seite so vergrößert, dass der Begrenzungsrahmen der Seite auf jeden Fall vollständig im Fenster sichtbar ist. Eine Dimension des Begrenzungsrahmens der Seite füllt dann exakt das Fenster aus. Die andere Dimension des Begrenzungsrahmens der Seite ist dann kleiner als das Fenster und ist innerhalb des Fensters mittig zentiert.

FitBH

FitBH;Zahl1

Die angegeben Seite wird so angezeigt, dass die y-Koordinate Zahl1 der Seite genau am oberen Ende des Fensters angezeigt wird. Gleichzeitig wird die Seite genau so weit vergrößert, dass der Begrenzungsrahmen (BoundingBox) der Seite in der Breite das Fenster exakt ausfüllt.

FitBV

FitBV;Zahl1

Die angegeben Seite wird so angezeigt, dass die x-Koordinate Zahl1 der Seite genau am linken Rand des Fensters angezeigt wird. Gleichzeitig wird die Seite genau so weit vergrößert, dass der Begrenzungsrahmen (BoundingBox) der Seite in der Höhe das Fenster exakt ausfüllt.

BarcodeRange

String

Diese Property enthält eine Liste von Barcodetypen, die durch Strichpunkte voneinander getrennt sind. Alle Bilder im PDF werden dahingehend überprüft, ob es sich um Barcodes der angegebenen Typen handelt. Die Suche kann auch auf Bereiche des PDFs eingeschränkt werden.

Syntax:

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

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

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

<pagenumber> ::= <Integer>

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

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

<rangeleft> ::= <Integer>

<rangebottom> ::= <Integer>

<rangeright> ::= <Integer>

<rangetop> ::= <Integer>

<rangeleft>, <rangebottom>, <rangeright>, <rangetop> sind positive ganze Zahlen in mm, der Ursprung (0;0) ist die linke untere Ecke der PDF-Seite.

„ “: (Property ist leer) Es werden alle Bilder des PDFs auf Barcode Informationen untersucht und dies wird mit den beiden Barcodetypen „QR“ und „DataMatrix“ durchgeführt. (default)

Ist die Property falsch belegt, wird der Errorcode 100 zurückgeliefert.

Beispiele siehe unten.

Set

BarcodeInfo

String

In diese Property werden die ausgelesenen Barcode-Informationen zurückgeliefert.
Falls eine Ausgabedatei (OutputFilename) und ein Speicherbereich (MemoryOutputCallback) angegeben werden, erfolgt die Ausgabe zusätzlich in diese Datei und in den Speicher.

Hinweis:
Durch einzelne Angaben (Ausgabedatei oder Speicherbereich) oder komplett ohne Angabe, wird der Wert für BarcodeInfo gar nicht gesetzt“.

Wird im angegebenen Bereich kein Barcode gefunden, bleibt die Property/Ausgabedatei leer.

Das Format der Ausgabe ist abhängig vom Inhalt der Property OutputFormat. Möglich sind OutputFormat= FormatBarcodeXml /FormatBarcodeCsv.

Der Koordinatenursprung (0;0) ist die linke untere Ecke der PDF-Seite.

OutputFormat=FormatBarcodeXml :

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

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

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

<pagenumber> ::= <Integer>

<imageleft> ::= <Integer>

<imagebottom> ::= <Integer>

<imageright> ::= <Integer>

<imagetop> ::= <Integer>

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

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

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

<barcodecontent> ::= <Text>

OutputFormat=FormatBarcodeCsv:

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

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

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

<pagenumber> ::= <Integer>

<imageleft> ::= <Integer>

<imagebottom> ::= <Integer>

<imageright> ::= <Integer>

<imagetop> ::= <Integer>

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

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

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

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

Hinweise zu CSV:

-           Sollte der Original-Barcodetext ein Anführungszeichen  “ enthalten, so wird dies im CSV-Format durch zwei hintereinander folgende Anführungszeichen  “”  ersetzt.

-           Jedes Barcodeimage hat eine eigene “<onebarcodeimagerow>”-Zeile. Sollte ein Pdf-Image aus Bild und Maske bestehen und sollten beide Barcodeinformationen enthalten, werden sie als zwei “<onebarcodeimagerow>”-Zeilen eingetragen mit gleicher Seitennummer und gleichem Rechtsbereich.

-           Für jedes Barcodeimage werden die Barcodeinfos für verschiedene Barcodetypes am Ende durch den Strichpunkt getrennt angegeben. Dabei wird für jede Barcodeinfo erst der Barcodetype und dann der Barcodecontent angegeben.

-           Damit jede CSV-Zeile aus der gleichen Anzahl von (durch Strichpunkt getrennte) Spalten besteht, sind bei den einzelnen CSV-Zeilen (= <onebarcodeimagerow>) am Ende entsprechend viele “;;” angehängt.

Beispiele siehe unten.

Get

OCRDebug

String

Diese Property ist nur für technische Testzwecke von Bedeutung. Sie steuert die Ausgabe der Bilder aus dem PDF.

Mögliche Werte:

„1“     Die Zwischenschritte der Barcodeextraction mittels OCR werden als einzelne Dateien ausgegeben.

„0“     Keine Ausgabe Zwischenschritte (default)

Für jedes einzelne Bild im Pdf Dokument, welches an die CIB Ocr Dll übergeben wurde, werden mehrere Dateien ausgegeben:

-           Das Bild selbst als Bitmap wie es an OCR übergeben wurde.

-           Das Barcode Ergebnis der CIB Ocr Dll, falls das Barcodeergebnis nicht leer ist. Falls das Barcodeergebnis leer ist, wird diese Datei nicht ausgegeben.

Die Dateien werden in das gleiche Verzeichnis geschrieben wie die Ausgabedatei. Die Namen dieser Dateien haben folgende Form:

“Ausgabedatei”__Page_”Seitennummer”_Image_“Bildnummer“_“Dateiendung“

Für die “Dateiendung” gilt dabei:

-        Für die Bitmapdatei: „.bmp“

-        Für das Barcodeergebnis der CIB Ocr Dll: „_BARCODE.txt“

Beispiel:
Lautet das Ausgabedokument „Output.xml“, so werden für das 4. Bild der 3. Seite folgende Dateien ausgegeben:
Output.xml__Page_3_Image_4.bmp
Output.xml__Page_3_Image_4_BARCODE.txt

Set

Propertybezeichnung

Funktionalität

Art

PdfLayers

Syntax:

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

Wobei:

Id1...IdN sind numerische IDs der optionalen Inhaltslayer, und der State der Ebene ist "Off" (Aus, unsichtbar) oder "On" (Ein, sichtbar).

Hinweis:

Nach der ersten Verarbeitung einer PDF-Datei kann eine äußere Anwendung Informationen über die vorhandenen OC-Gruppen für die Standardkonfiguration aus der Ausgabeeigenschaft PdfLayersInfo erhalten.

Nach Kenntnis dieser Informationen kann die äußere Anwendung beliebige Zustände (sichtbar/nicht sichtbar) für beliebige OC-Ebenen anfordern.

Set

PdfLayersInfo

Die Ausgabeeigenschaft gibt Informationen über die vorhandenen optionalen Inhaltsebenen und ihre Zustände aus.

Syntax:

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

Wobei:

Tree ist ein Array, das die hierarchische Struktur der vorhandenen Ebenen in PDF beschreibt.

Tree enthält die Elemente: <LayerDescription> die eine Beschreibung jeder Ebene ist:

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

 Wobei:

"LayerId": <Id> ist eine eindeutige Nummer, (Layer-Bezeichner, der für die Eingabeeigenschaft PdfLayers verwendet werden soll).

Locked: true/false zeigt an, ob ein Benutzer den aktuellen Zustand der Schicht umschalten kann.

Kids: Array, das alle Kids des layers beschreibt.

PageLayers ist eine Anordnung von Seiten und ihren Layern: <PageLayersDescription>

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

 <PageId> ist ein Index einer Seite, beginnend mit 0

LayerIds ist ein Array von <LayerId> (numerische ID), das auf entsprechende LayerIds aus dem Tree-Objekt abgebildet werden kann.

Hinweis:

1. Wenn LayerDescription nur Name und Kids (keine LayerId- und State-Einträge) enthält, handelt es sich nicht um einen echten Layer, sondern um einen einfachen Knoten, der auf- und zugeklappt werden kann und weitere Layer enthält.Wenn LayerDescription alle Einträge enthält und auch Kids hat, dann ist der Layer ein Knoten, der ein- oder ausgeschaltet werden kann und auch andere Layer enthält.

2. Eine neue Aktion vom Typ SetOcgState wird zusätzlich in die Metadatei ausgegeben, um OCG-Switching mit Hilfe von Formularfeldern und Widget-Annotationen zu ermöglichen.

3. Die Output Property PDFLayersInfo wird auch mit OutputFormat=FormatInfo mit der entsprechenden FilterInfo ausgegeben.

Get

OutputFormat

String

FormatSearchablePdf

Set

CurrentProgress

(ab CIB pdf toolbox Version 1.24.0

String

Über diese Property kann der Fortschritt des Texterkennungs-Prozesses von CIB ocr abgefragt werden.
Die CIB pdf toolbox überträgt hierbei unverändert den Inhalt der Methode CibOcrJobGetProgress des CIB ocr Moduls.

Die Property enthält damit einen String mit dem Aufbau:
<Aktuelle Seitennummer> <Gesamtzahl Seiten> <Verarbeitungsfortschritt für aktuelle Seite>

Für Details siehe „Technischer Leitfaden CIB ocr“, Kapitel „CibOcrJobGetProgress“

Get

DictionaryWorkSpace

String

Mit dieser Property hat man die Möglichkeit, den Pfad für die von CIB ocr benötigten Daten zu setzen.

Set

FormatSearchablePdfShowText

String

Es kann gesteuert werden, ob der in das Ausgabe-PDF eingefügte Text sichtbar ist oder nicht.

„1“       Text ist sichtbar

„0“       Text ist nicht sichtbar (default)

Set

FormatSearchablePdfRemoveImages

String

Es kann gesteuert werden, ob im Ausgabe-PDF die Bilder entfernt werden oder nicht.
Ein Setzen dieser Property ist nur möglich, falls „HocrInputData“ leer ist, und ist nur in Verbindung mit „FormatSearchablePdfShowText=1“ sinnvoll. Dann sind in dem Ausgabe PDF die Bilder durch sichtbaren Text ersetzt.

„1“       Bilder werden entfernt

„0“       Bilder bleiben erhalten (default)

Set

PdfVersion

(ab Version 1.6.116b)

String

Optional kann bei OutputFormat=FormatSearchablePdf auch die Property PdfVersion gesetzt werden. Dann entspricht das erzeugte PDF dem angegebenen PDF/A-Standard.

Hinweis: dies wird im Moment nur in Kombination mit FormatSearchablePdfShowText=0 unterstützt.

Mögliche Werte:

PDF/A-1b

PDF/A-2b

PDF/A-3b

Set

HocrInputData

(ab Version 1.9.0, Multi-Page-Format ab Version 1.10.0)

String

Mit diesem String hat man die Möglichkeit der Toolbox die Hocrdaten direkt zu importieren (anstatt sie aus den Bildern des Pdf Dokuments zu extrahieren). Ist dieser String leer (default), wird er nicht verwendet.

Ansonsten umfasst er eine Liste von Speicheradressen und Längen für Strings, die die Hocrdaten enthalten. Er muss in folgendem Format vorliegen:

Syntax:

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

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

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

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

MemoryBlock-Delimiter ::= Ein einzelnes Zeichen, das ungleich ‚;‘ und ‚\0‘ ist, z.B. ‚#‘ oder ‚?‘, am besten auch keine Ziffern oder Buchstaben.

Pagenumber ::= Seitennumber der Seite, für die die Hocrdaten angegeben werden.

Address :== Eine Dezimalzahl, welche die Adresse für einen Speicherbereich (memory block) für die Hocrdaten angibt.

Length ::= Eine Dezimalzahl, welche die Länge eines Speicherbereichs für die Hocrdaten angibt.

Beispiel:

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

Seite 1 hat Hocrdaten in den Speicherbereichen (Adresse, Länge) (111, 100) und (222, 200); Seite 2 hat Hocrdaten in dem Speicherbereichen (113, 100); Seite 3 hat Hocrdaten in den Speicherbereichen (300, 100) und (400, 200).

Seit der Toolbox Version 1.10.0 ist auch ein Multi-Page-Format möglich:

Falls das erste Zeichen ungleich „{“ ist, so wird nur ein XML-HOCR-File angegeben. Dieses kann verschiedene einzelne XML-HOCR-Seiten umfassen. Die Datei muss in einem besonderen Format vorliegen, wie es z.B. von CIB format mit der Eigenschaft OutputFormat=FormatHocr erzeugt wird.

Set

HocrOutputFilename (ab Version 1.9.0)

String

Falls der String leer ist, werden keine Hocrdaten rausgeschrieben (default).

Falls der String nicht leer ist, werden in die Datei mit diesem Dateinamen alle verwendeten Hocrdaten als Multi-Hocr-Datei geschrieben.     Vor jedem einzelnen „Hocrteil“ wird die Zeile „<!-- CIB:page=Seitennummer -->“ geschrieben, wobei „Seitennummer“ die Seitennumer für den Hocrteil ist. (Z.B. „<!-- CIB:page=3 -->“ = Hocrdaten für Seite 3). Texte wie ‚CIB ocr testlicense‘ werden aus den Hocrteilen entfernt.

Set

OCRDebug

String

Diese Property ist nur für technische Testzwecke von Bedeutung. Sie steuert die Ausgabe der Bilder aus dem PDF.

Mögliche Werte:

„1“     Die Zwischenschritte der Barcodeextraction mittels OCR werden als einzelne Dateien ausgegeben.

„0“     Keine Ausgabe Zwischenschritte (default)

Für jedes einzelne Bild im Pdf Dokument, welches an die CIB Ocr Dll übergeben wurde, werden mehrere Dateien ausgegeben:

-           Das Bild selbst als Bitmap wie es an OCR übergeben wurde.

-           Das Barcode Ergebnis der CIB Ocr Dll, falls das Barcodeergebnis nicht leer ist. Falls das Barcodeergebnis leer ist, wird diese Datei nicht ausgegeben.

Die Dateien werden in das gleiche Verzeichnis geschrieben wie die Ausgabedatei. Die Namen dieser Dateien haben folgende Form:

“Ausgabedatei”__Page_”Seitennummer”_Image_“Bildnummer“_“Dateiendung“

Für die “Dateiendung” gilt dabei:

-        Für die Bitmapdatei: „.bmp“

-        Für das Barcodeergebnis der CIB Ocr Dll: „_BARCODE.txt“

Beispiel:
Lautet das Ausgabedokument „Output.xml“, so werden für das 4. Bild der 3. Seite folgende Dateien ausgegeben:
Output.xml__Page_3_Image_4.bmp
Output.xml__Page_3_Image_4_BARCODE.txt

Set

FormatSearchablePdfTextColor

(ab Version 1.10.0)

String

Diese Eigenschaft wird nur verwendet, falls OutputFormat=FormatSearchablePdf und FormatSearchablePdfShowText=“1“ und das erste Zeichen von HocrInputData ungleich ‚{‘ ist. Sie gibt die Farbe für den eingefügten Text an.

Mögliche Werte:

-           leerer String (default): Es wird schwarz als Standardtextfarbe verwendet.

-           Die Textfarbe ist gegeben in der Form „R;G;B“, wobei R, G und B natürliche Dezimalzahlen zwischen 0 und 255 sind. (R ist der Rotanteil, G ist der Grünanteil und B ist der Blauanteil). Z.B. „255;0;0“ ist rot.

Set

FormatSearchablePdfLayerName

(ab Version 1.10.0)

String

Diese Eigenschaft wird nur verwendet, falls OutputFormat=FormatSearchablePdf und FormatSearchablePdfShowText=“1“ und das erste Zeichen von HocrInputData ungleich ‚{‘ ist.

Sie gibt (falls angegeben) den Pdf-Ebenennamen (im Adobe Reader) für den eingefügten Text an.

Mögliche Werte:

-           Leerer String (default): Der eingefügte Text ist nicht Teil irgendeiner Pdf-Ebene.

-           Der eingefügte Text ist Teil der Pdf-Ebene mit diesem Ebenennamen.

Set

FormatSearchablePdfDTDFolder

(ab Version 1.10.0)

String

Diese Eigenschaft wird nur verwendet, falls OutputFormat=FormatSearchablePdf und FormatSearchablePdfShowText=“1“ und das erste Zeichen von HocrInputData ungleich ‚{‘ ist.

Sie ist eine Hilfseigenschaft und gibt (falls angegeben) den lokalen Pfad für die XHTML-DTD-Datei xhtml1-transitional.dtd an. Der Hintergrund ist: Der XML Parser liefert eine NetAccessorException. Und die W3C sagt, dass die Aufrufe der DTDs lokal gespeichert werden sollen.

Mögliche Werte:

-           Leerer String (default): Es wird nichts gemacht.

-           Die URL für xhtml1-transitional.dtd im HOCR-XML-file von HocrInputData wird durch einen Verweis auf die lokale Datei gleichen Namens ersetzt.

Set

FormatSearchablePdfConversionMode

(ab Version 1.18.0)

String

Diese Property definiert, in welcher Form die im PDF enthaltenen Bilder an CIB ocr übergeben werden.

Mögliche Werte:

FormatSearchablePdfConvertImages
Das bisherige Verhalten wird angewendet, d.h. jedes Bild einer Seite wird als eigenes Objekt behandelt.

FormatSearchablePdfConvertPages
Jede Seite wired in ein einziges Bild umgewandelt und an CIB ocr übergeben. Die Auflösung dieses Bildes kann über die Property TiffResolution gesteuert werden (Empfohlen sind Werte ab TiffResolution=150).

FormatSearchablePdfConvertAuto
Auf Seiten, die nur ein einziges Bild enthalten, wird das bisherige Verhalten angewendet. Auf alle anderen Seiten das Verhalten von „FormatSearchablePdfConvertPages“. . (Default)

Set

FormatSearchablePdfUseRotationHint

(ab Version 1.18.0

String

Wenn diese Property gesetzt ist, wird für jede Seite des PDFs die Information über eine Rotation an CIB ocr übergeben. Das verbessert die Erkennungsrate von CIB ocr bei gedrehten Seiten.
Dazu verwendet die CIB pdf toolbox die CIB ocr Property ImageRotationAngle.

Mögliche Werte:

0          Bisheriges Verhalten

1         Übergabe der Informationen über die Seiten-Rotation an CIB ocr. (Default)

Set

FormatSearchablePdfReplaceText

String

Diese Eigenschaft ist nur gültig für OutputFormat=FormatSearchablePdf

Wenn die Eigenschaft FormatSearchablePdfReplaceText NICHT gesetzt ist, wird das ursprüngliche Verhalten verwendet: pdf toolbox fügt immer neue CIB HOCR-Inhalte hinzu, ohne bestehende zu entfernen.

Wenn die Eigenschaft auf FormatSearchablePdfReplaceText=1 gesetzt ist, entfernt die pdf toolbox vorhandenen unsichtbaren CIB HOCR-Inhalt aus dem verarbeiteten Dokument, bevor ein neuer Inhalt hinzugefügt wird.

Die neue Eigenschaft FormatSearchablePdfReplaceText kann auch in Verbindung mit TextSelectionFilter verwendet werden:

Wenn FormatSearchablePdfReplaceText=1 und TextSelectionFilter einen Filter enthält, wird dieser Filter verwendet, um Text aus dem Originaldokument zu entfernen, bevor neuer HOCR-Text hinzugefügt wird.

Beispiele:

1. OutputFormat=FormatSearchablePdf FormatSearchablePdfReplaceText=1 - entfernt vorhandenen CIB-HOCR-Text, bevor neuer HOCR-Text hinzugefügt wird

2. OutputFormat=FormatDurchsuchbarPdf FormatSearchablePdfReplaceText=1 TextSelectionFilter={"Gruppen":["beliebig_unsichtbar"]} - entfernt jeglichen unsichtbaren Text (einschließlich CIB HOCR), bevor neuer HOCR-Text hinzugefügt wird.

Typ

Variable

Bedeutung

char*

a_pOptionName

Name des gewünschten Konfigurationsparameters

void*

a_pOptionValue

Wert des gewünschten Konfigurationsparameters

Achtung:

Beachten Sie den Datentyp des jeweiligen Wertes

char*

a_pOptionName

Name des gewünschten Konfigurationsparameters

void*

a_pOptionValue

Wert des gewünschten Konfigurationsparameters

long

a_lBufferLength

Länge des Puffers für den Optionsinhalt

unsigned long &

a_lVersion

a_lVersion liefert die aktuelle Versionsnummer der CIB pdfm Komponente zurück. Der unsigned long-Wert liefert die Informationen in zwei Bereichen. Die ersten zwei Bytes enthalten den Versionszähler des Hauptreleases. Die Bytes 3 und 4 enthalten den zugehörigen aktuellen Releasezähler. Je nach Programmiersprache sind die Hi- und Lowbereiche entsprechend zu beachten (siehe  Schneller Einstieg).

long

a_hJob

Handle des auszuführenden Auftrags

int *

a_iError

Platzhalter für die aktuelle Fehlernummer

int

a_iErrorId

Fehlernummer

char

a_pTextBuffer

Textpuffer für den Fehlertext

long

a_lBufferLength

Länge des verfügbaren Textpuffers

int

a_iError

Platzhalter für die aktuelle Fehlernummer

int

a_pTextBuffer

Textpuffer für den Fehlertext

long

a_lBufferLength

Länge des verfügbaren Textpuffers

int

pageIndex

Index der aktuellen Seite (0-basiert)

size_t

pageWidth
pageHeight

Breite und Höhe der aktuellen Seite in Pixel und der Standard-Auflösung von 72dpi

int

pageIndex

Index der aktuellen Seite (0-basiert)

size_t

imageWidth
imageHeight
imageStride

Die Standard-Parameter einer Bitmap im DIB-format

(DIB = geräteunabhängiges Bitmap Format)

char*

Data

Komplette Bitmap im DIB-Format

size_t

imageLength

Deren Länge in Bytes

int*

a_iButtonId

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

1 (COMOD_ID_OK)       OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

2 (CIB_ID_CANCEL)      Abbrechen-Button

int*

a_iButtonId

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

CIB_ID_OK                     OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

CIB_ID_CLOSE                Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

CIB_ID_CANCEL             Abbrechen-Button

int*

a_iButtonId

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

CIB_ID_OK                     OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

CIB_ID_CLOSE                Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

CIB_ID_CANCEL             Abbrechen-Button

char*

a_TextOutput

Die Daten, die über die Callbackfunktion übergeben werden.

size_t

a_Length

Die Byte-Anzahl der Daten.

void*

a_pUserdata

Zeiger auf beliebige Nutzerdaten.
Konkreter Typ hängt von der Implementierung der Callbackfunktion ab.

Int*

a_Error

Fehlercode, der vom Aufrufer an die Callbackfunktion übergeben wird.

ABORTDOCINFO*

a_AbortDocInfo

Die Daten, die über die Callbackfunktion übergeben werden.

void*

a_pUserdata

Zeiger auf beliebige Nutzerdaten.
Konkreter Typ hängt von der Implementierung der Callbackfunktion ab.

CibPdfJobHandle*

a_pJob

Handle des auszuführenden Auftrags

char*

a_pReserved

CibPdfJobHandle*

a_pJob

Handle des freizugebenden Auftrags

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

Int*

a_pButtonID

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

1 (COMOD_ID_OK)       OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

2 (CIB_ID_CANCEL)      Abbrechen-Button

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

Int*

a_pButtonID

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

1 (COMOD_ID_OK)       OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

2 (CIB_ID_CANCEL)      Abbrechen-Button

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

Int*

a_pButtonID

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

1 (COMOD_ID_OK)       OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

2 (CIB_ID_CANCEL)      Abbrechen-Button

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

char*

a_pName

Name der gewünschten Property

void*

a_pValue

Wert der gewünschten Property

size_t

a_MaxLength

Länge des Puffers für den Optionsinhalt

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

char*

a_pName

Name der gewünschten Property

void*

a_pValue

Wert der gewünschten Property

size_t

a_Length

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

wchar-t*

a_pName

Name der Property in wchar_t* (UNICODE)

wchar-t*

a_pValue

Wert der Property in wchar_t* (UNICODE)

size_t

a_MaxLength

Die Byte-Anzahl der Daten

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

wchar-t*

a_pName

Name der Property in wchar_t* (UNICODE)

wchar-t*

a_pValue

Wert der Property in wchar_t* (UNICODE)

size_t

a_MaxLength

Die Byte-Anzahl der Daten

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

int*

a_pErrorCode

Platzhalter für die aktuelle Fehlernummer

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

char*

a_pText

Textpuffer für den Fehlertext

size_t

a_MaxLength

Länge des verfügbaren Textpuffers

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

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

DocumentUsedFonts

(ab CIB pdf toolbox 1.6.115)

String

Ausgabe der in einem Dokument verwendeten Schriftarten {Name;Größe;Attribute}.

Beispiel:
{Frutiger VR;6-48;normal,bold,italic,bold italic;};{Courier New;6-48;normal,bold,italic,bold italic;}

DocumentReplacedFonts

(ab CIB pdf toolbox 1.6.115)

String

Ausgabe der bei der Dokumenten-Verarbeitung erfolgten Font-Ersetzungen.

Falls ein Font auf dem System nicht vorhanden ist, wird er von der CIB pdf tollbox  durch einen möglichst „ähnlichen“ installierten Font ersetzt. Die durchgeführten Font-Ersetzungen werden in dieser Property dokumentiert in der Form:

<Font-Ersetzungen> ::= <Font-Ersetzung> | <Font-Ersetzung> „;“<Font-Ersetzung>

<Font-Ersetzung> ::= „{“ <Alter Font> „;“<Neuer Font> „}“

<Alter Font> ::= <Fontname>

<Neuer Font> ::= <Fontname>

<Fontname> ::= <Text>

Jede Font-Ersetzung wird nur einmal ausgegeben.

Beispiel:
DocumentReplacedFonts = {FrutigerVR;Times};{HelveticaNeueLT Com 65Md;Times};{Arial;Times}

DocumentUsedOriginFonts

(ab CIB pdf toolbox 1.6.115)

String

Ausgabe der in einem Dokument verwendeten Original-Schriftarten {Name;Größe;Attribute}.

Beispiel:
{Frutiger VR;6-48;normal,bold,italic,bolditalic;};{Arial;10,12;normal,bold italic;}

DuplexPrint2

Char*

DuplexPrint2 erweitert die Ausprägung für den Duplexdruck und wird anstatt der Property DuplexPrint verwendet.

„DuplexDefault“:
Es wird unter Windows der im Druckertreiber gesetzte Standardwert verwendet. Unter Linux/Unix wird der Wert aus der per Property gesetzten PPD-Datei verwendet. Ist keine PPD-Datei vorhanden, wird DuplexPrintLong verwendet.

„DuplexPrintShort“:
Es wird beidseitig bedruckt, wobei das Blatt wie bei einem Kalender an der kurzen Seite gedreht wird.

„DuplexPrintLong“:
Es wird beidseitig bedruckt wobei das Blatt wie bei einem Buch an der langen Seite gedreht wird.

„SimplexPrint“:
Es wird einseitig bedruckt.

PageSelection

Char*

Geben Sie hier die gewünschte Seitenselektion an.
zum Beispiel:

Die Angabe „1-3“ entspricht Seite 1 bis 3,
durch die Angabe „1;3“ erhält man Seite 1 und 3. (Semikolon als Trennzeichen !)

Angabe von Ausfertigungen:
<Textmarkenname>;<Textmarkenname2>
oder
<Textmarkenname>,<Anzahl zusätzl. Kopien>
Hinweis:
Semikolon trennt die Namen der Ausfertigungen. Mit Komma werden die Anzahl zusätzlicher Kopien angefügt.

(ab CIB pdf toolbox 1.4.83):
Anstelle eines Seitenbereichs, kann man auch den Namen einer Ausfertigung (Bookmark) eines zum Pdf konvertiertem RTF Dokuments angeben.

PaperBin

Char*

Gezielte Ansteuerung eines bestimmten Drucker-Schachtes.

Möglich sind:
- Druckerspezifische Schachtnummern,
            z.B. 258
            (ab CIB pdf toolbox 1.4.109)
- Druckerspezifische Schachtbezeichner
            z.B. Fach 1
- System-Standardschächte:
            „BinOnlyOne“
            „BinLower“
            „BinManual“
            „BinMiddle“
            „BinUpper“
            „BinLargeCapacity“
            „BinTray5“
            „BinEnvelope“
            „BinDefault“

Achtung:
Die System-Standardschächte werden nicht von jedem Druckertreiber unterstützt, was zu einem Ausdruck auf dem Standardschacht des jeweiligen Druckers führt.

Es ist möglich, für die erste Seite und den Rest des Dokuments unterschiedliche Schächte anzusteuern. Die beiden Schächte werden dann durch Semikolon getrennt.

Beispiel:
PaperBin=“258;260“

PaperBinReset

Char*

Erste Seite wird auf einem anderen Schacht gedruckt. Mögliche Werte:

=„Bookmarks“ (Default)
Die erste Seite jeder Kopie, Ausfertigung und jedes Teil-Dokuments wird auf den Erste-Seite-Schacht gedruckt.

=“PartialDocuments“
Die erste Seite jeder Kopie und jedes Teil-Dokuments wird auf den Erste-Seite-Schacht gedruckt.

=“Copies“
Die erste Seite jeder Kopie wird auf den Erste-Seite-Schacht gedruckt.

=“None“
Die erste Seite des Druckauftrages wird auf den Erste-Seite-Schacht gedruckt

ReceiverCopyMap

(ab CIB pdftoolbox 1.4.106)

(ab CIB pdftoolbox 1.14.0)

Char*

In einer Tabelle können den in den Dokumenten gesetzten Textmarken (Ausfertigungen, AUSFn) sprechende Namen zugeordnet werden.
Die hier vergebenen Namen können in der Property PageSelection verwendet werden.

Syntax:
<r-copy> | <r-copy> “;” <ReceiverCopyMap>

<r-copy> ::= „{“ <NameNeu> „;“ <Textmarke> „;“
<PapiertypSeite1> „;“ <PapiertypRest> „}“

<NameNeu> ::= <leer> | <Text>

<Textmarke> ::= <Text>

<PapiertypSeite1> ::= <leer> | <Text>

<PapiertypRest> ::= <leer> | <Text>

Beispiel:
ReceiverCopyMap={kunde;AUSF1;briefkopf;brief};{bank;AUSF2;blanko;blanko}

Spezialfall:  Einer der beiden Schächte fehlt:

ReceiverCopyMap=
{kunde;AUSF1;briefkopf;}   oder

{kunde;AUSF1;briefkopf}   oder

{kunde;AUSF1;;briefkopf}

haben das gleiche Ergebnis:
Nach der 1. Seite wird keine Duplexleerseite eingefügt.

Aber:

ReceiverCopyMap=
{kunde;AUSF1;;}   oder

{kunde;AUSF1;}

erzeugen einen Fehler - 304.

PaperTypeMap

(ab CIB pdftoolbox 1.4.106)

Char*

In einer Tabelle können den verwendeten Papiertypen die Druckerschächte zugeordnet werden, in denen dieses Papier liegt.
Schachtnamen bzw. Schachtnummern sind Drucker spezifisch.
Das Belegen dieser Tabelle ist Voraussetzung für Papiertyp bezogenes Drucken. Ansonsten erfolgt der Ausdruck auf den Default-Schacht des Druckers (oder auf Schächte, die durch andere Properties festgelegt wurden.

Syntax:
<PaperTypeMap> ::= <Eintrag> | <Eintrag> „;“ <PaperTypeMap>

<Eintrag> ::= <Papiertyp> „,“ <Schacht>

<Papiertyp> ::= <Text>

<Schacht> ::= <Text> | <Nummer>

Beispiel:
PaperTypeMap={briefkopf,Schacht1;
brief,Schacht2;blanko,260}.

PaperTypes

(ab CIB pdftoolbox 1.4.106)

Char*

Es können Default-Papiertypen für den Ausdruck festgelegt werden, falls keine ReceiverCopyMap vorhanden ist. Es sind maximal zwei Papiertypen möglich (für Gesamtdokument oder für 1. Seite und den Rest).
Voraussetzung für diese Property ist eine Zuordnung der Papiertypen zu Drucker­schächten über PaperTypeMap.
Die gesetzten Papiertypen werden entweder pro Ausfertigung (gemäß PageSelection) oder auf das ganze Dokument angewendet.

Syntax:
<PaperTypes> ::= <Papiertyp> | <Papiertyp> „;” <Papiertyp>

<Papiertyp> ::= <Text>

Beispiel:

PaperTypes=briefkopf;brief

PrintBracketMode

(ab CIB pdftoolbox 1.4.106)

Char*

Es können mehrere Druck-Dokumente in einem Druckauftrag geklammert werden. Dadurch wird vermieden, dass sich Druckseiten von unterschiedlichen Personen mischen und danach per Hand auseinander sortiert werden müssen. Bei diesen Dokumenten kann es sich um RTFs oder PDFs (auch gemischt) handeln.

Mögliche Werte:

Open PrintBracket ist leer:
Öffnen einer neuen Druckklammer mit erstellen eines Handles, das in PrintBracket gespeichert wird. Das Dokument wird der Druckklammer hinzugefügt.
PrintBracket ist belegt:
Das Dokument wird der Druckklammer hinzugefügt.
In beiden Fällen ist die Übergabe eines Dokuments (InputFilename oder InputMemoryAddress) zwingend erforderlich, ansonsten Fehler­mel­dung.

Close PrintBracket ist leer:
Das einzelne Dokument wird gedruckt. Übergabe eines Dokuments (InputFilename oder InputMemoryAddress) ist damit zwingend erforderlich, ansonsten Fehler­mel­dung.
PrintBracket ist belegt:
Das Dokument (falls vorhanden) wird der Druckklammer hinzugefügt. Die Druckklammer wird geschlossen, das Handle freigegeben. Der Spooler übernimmt den Druckauftrag.

Cancel PrintBracket ist leer:
Ausgabe einer Fehlermeldung, da keine Druckklammer existiert, die abgebrochen werden kann.
PrintBracket ist belegt:
Die Druckklammer wird verworfen, d.h. das Handle freigegeben ohne dass ein Druckauftrag erfolgt.

PrintBracket

(ab CIB pdftoolbox 1.4.106)

Long

Bei Starten einer neuen Druckklammer (PrintBracketMode=Open) erstellt die CIB pdf toolbox (oder der CIB format) ein neues Druckklammer-Handle. Dieses Handle wird in der Property PrintBracket hinterlegt.

Dieses Handle weist auf die Druckauftrag-Instanz, wo Verwaltungsinformationen (printed pages, printed documents, etc.) gespeichert sind und zusätzlich unter
Windows: das Spoolerhandle
Linux: eine Liste von Dateipfaden

PrintMode

(ab CIB pdftoolbox 1.13.0)

Char*

Wirkt nur unter Windows

Bei RenderingEngine=CIBRenderer wird für den Rendering-Vorgang des Drucks (OutputFormat=FormatPrinter) der CIBRenderer verwendet und erzeugt als Zwischenschritt temporäre Files, die dann an den Drucker übergeben werden.

Mögliche Werte:

Auto (oder leer): Es wird Postscript benutzt, wenn der Druckertreiber postscriptfähig ist, ansonsten GDI.

Postscript: Es wird Postscript benutzt, wenn der Druckertreiber postscriptfähig ist.
(Sonst Fehler 304)

GDI: Druck über GDI

PCL: Wird noch nicht unterstützt
(Ausgabe Fehler 304)

Die Properties PrintBrackets, PageSelection, PrintCopies2, DuplexPrint2, SortedPrint2, PaperBins, InsertEmptyPageBetweenBookmarks, PaperBinReset können benutzt werden.

Bei RenderingEngine ungleich CIBRenderer wird nur GDI unterstützt.
D.h. ist PrintMode leer oder Auto oder GDI, wird GDI benutzt. Ansonsten gibt es Fehler 304

ParentHwnd2

Char*

Es wird das Windowhandle der Anwendung übergeben, bezüglich der der Druckdialog zentriert werden soll.

(default: Windowhandle des Desktops)

PrintCopies2

Char*

Anzahl der Kopien vom Original, die beim Ausdruck erzeugt werden.
Angabe ist die Zahl der zusätzlichen Exemplare, default ist 0.

SortedPrint2

(ab CIB pdf toolbox 1.6.117)

Char*

Ausgabe von sortierten oder unsortierten Kopien auf den Drucker. Diese Property ist nur sinnvoll, falls PrintCopies2 > 0 ist. Diese Eigenschaft wird sowohl für Simplexdruck als auch für Duplexdruck unterstützt.

Mögliche Werte:

„1“: Die Seiten des Pdf Dokuments werden sortiert gedruckt (default).

„0“: Die Seiten des Pdf Dokuments werden unsortiert gedruckt. In diesem Fall wird die Property RequestedPages nicht unterstützt.

Außerdem gilt:
 Falls FastPages=1 oder PaperTypeMap nicht leer ist oder ReceiverCopyMap nicht leer ist oder PaperBin einen Strichpunkt (für 2 Schächte) enthält, so wird eine Warnung rausgeschrieben und der Wert von SortedPrint2 auf „1“ geändert.

Beispiel:
Für PageSelection=“3;6;8“, PrintCopies2=1 und Duplex-Print wird für SortedPrint2=1 ausgegeben: „3,6,8,leer,3,6,8,leer“.

Für SortedPrint2=0 wird ausgegeben:
„3,6,3,6,8,leer,8,leer“. Das Ganze im Simplex-Print ergibt „3,6,8,3,6,8“ (für SortedPrint2=1) und „3,3,6,6,8,8“ (SortedPrint2=0).

PrinterChanged2

Char*

„1“: Drucker wurde geändert.

„0“: Der Drucker wurde nicht geändert.

PrinterLocalisation

Char*

Definition der Druckertypen die mit PrinterAvailable geholt werden sollen

„PrinterDefault“:
Liefert den Standarddrucker.

„PrinterLocal“:
Liefert die lokalen Drucker.

„PrinterNetwork“:
“PrinterRemote“:
“PrinterShared“:
Liefert die über das netzwerk angeschlossenen Drucker.

„PrinterCUPS“:
Liefert die über das Common Unix Printing System angeschlossenen Drucker.

PrintedPageCount2

Char*

Liefert die Anzahl der gedruckten Seiten zurück.

PrinterName

Char*

Windows:
Unter Windows wird der gewünschte Druckername verlangt. Die Angabe kann mit Domain oder Serverbezeichnung erfolgen.

PrintToFile2

Char*

„0“: der Ausdruck geht auf den gewünschten Drucker

„1“: der Druck wird in eine Datei umgeleitet.

Diese Datei wird entweder im Benutzerdialog ermittelt oder kann über die Eigenschaft OutputFilename bereits vorher  gesetzt werden.

PrintDialogDisableToFile2

Char*

„1“: Im Druckdialog wird die Checkbox „Ausgabe In Datei umleiten“ nicht angezeigt.

„0“: Die Checkbox wird angezeigt (Default).

PrintDialogDisableSelection2

Char*

„1“: Die Optionen zum Auswählen einzelner Seiten im Druckdialog sind ausgegraut und können nicht verwendet werden.

„0“: Die Optionen zum Auswählen einzelner Seiten sind verfügbar (Default)

PrintDlgHwnd2

Char*

Windowhandle des verwendeten Druckdialoges

PrinterPortName

Char*

Auf diesem Port ausdrucken (Nur Get)

DefaultPrinter

Char*

Rückgabe des Standarddruckers.

PaperBinAvailable

Char*

Rückgabe der verfügbaren Druckerschächte des Druckers aus Property PrinterName bzw. des Standarddruckers, falls PrinterName leer ist.

DeviceCapability.DuplexAvailable

Char*

Gibt zurück, ob der Drucker aus Property PrinterName (oder der Standarddrucker, falls PrinterName leer ist) fähig ist, Duplex oder zweiseitig zu drucken.

Mögliche Rückgabewerte:
0        Er kann nicht Duplexs drucken
1        Er kann Duplex drucken

PrintCommentList

(ab CIB pdf toolbox 1.9.2)

Char*

Gibt an, ob die sichtbaren Kommentare beim Drucken aufgelistet werden sollen (entspricht dem „Kommentare zusammenfassen“ bei Adobe Professionell).

Mögliche Werte:

„0“: Es wird keine Kommentarliste gedruckt. (default)

„1“: Alle sichtbaren Kommentare des PDF Dokuments erhalten eine fortlaufende Nummer und sie werden in Zusatzseiten aufgelistet.

PrintCommentListTypes

(ab CIB pdf toolbox 1.9.2)

Char*

Die Property gibt an, welche speziellen Kommentartypen aufgelistet werden sollen.
Sie ist nur wirksam, falls PrintCommentList=“1“.

Mögliche Werte:

„“: (leerer String – default) Alle sichtbaren Kommentare werden aufgelistet.

Non-empty-string: Eine durch Strichpunkt getrennte Liste der Kommentartypen, die aufgelistet werden sollen.
Z.B. „Circle;Freetext;Text“.

PrintCommentListEmpty

(ab CIB pdf toolbox 1.9.2)

Char*

Gibt an, ob nur die Kommentare mit nicht-leerem Text aufgelistet werden.

Mögliche Werte:

„1“: Alle passenden Kommentare werden aufgelistet, egal ob sie Text enthalten oder nicht. (Default)

„0“: Es werden nur die Kommentare aufgelistet, die wirklich Text enthalten.

Komplettdruck des Dokuments

Keine erforderlich

Das komplette Dokument wird einmal ausgedruckt.

Komplettdruck mit Kopien

PrintCopies2=1

Das komplette Dokument wird zweimal gedruckt.

Ausdruck von Teilen des Dokuments

PageSelection=1-3;7

InsertEmptyPageBetweenRtfBookmarks=“1“

Gedruckt werden nur die Seiten 1, 2, 3 und 7.
Durch Setzen der Property „InsertEmptyPageBetweenRtf-Bookmarks“ wird verhindert, dass die Seite 7 auf die Rückseite von Seite 3 gedruckt wird.

Ausdruck von Teilen des Dokuments mit Kopien

PageSelection=1,1;5,2

InsertEmptyPageBetweenRtfBookmarks=“1“

Gedruckt werden nur die Seite 1 zweimal und Seite 5 dreimal.

Druck auf unterschiedliche Schächte

PaperBin=“BinManual;BinUpper“

Die erste Seite des Dokuments wird auf manuellen Schacht, der Rest auf oberen Schacht gedruckt.

Druck mit Kopien und unterschiedlichen Schächten

Variante 1

PrintCopies2=1

PaperBin=“BinManual;BinUpper“

PaperBinReset=Bookmarks

Die erste Seite jeder Kopie des Formulars wird auf manuellen Schacht, der Rest auf oberen Schacht gedruckt.

Variante 2

PrintCopies2=1

PaperBin=“BinManual;BinUpper“

PaperBinReset=None

Die erste Seite des Druckauftrags wird auf manuellen Schacht, der Rest auf oberen Schacht gedruckt

Komplettdruck des Dokuments

Keine weiteren Properties erforderlich

Das komplette Dokument wird einmal ausgedruckt. Es werden Leerseiten eingesteuert, damit jede Ausfertigung auf einem neuen Blatt beginnt.

Ausdruck von Teilen des Dokuments

PageSelection=AUSF2

Nur die Ausfertigung 2 wird gedruckt.

Ausdruck von Teilen des Dokuments mit und ohne Kopien

PageSelection=AUSF1,1;AUSF3

Die Ausfertigung 1 wird zweimal und Ausfertigung 3 einmal gedruckt.

Ausdruck auf unterschiedliche Schächte

Variante 1

PaperBin=“BinManual;BinUpper“

PaperBinReset=Bookmarks

Die erste Seite jeder der im Dokument enthaltenen Ausfertigungen wird auf manuellen Schacht, der Rest auf oberen Schacht gedruckt.

Variante 2

PaperBin=“BinManual;BinUpper“

PaperBinReset=None

Die erste Seite des Dokuments wird auf manuellen Schacht, der Rest auf oberen Schacht gedruckt

Ausdruck auf unterschiedliche Schächte mit Kopien

PrintCopies2=1

PaperBin=“BinManual;BinUpper“

PaperBinReset=Copies

Das komplette Dokument wird zweimal gedruckt. Dabei geht die erste Seite jeder Kopie auf den manuellen und die restlichen Seiten auf den oberen Schacht.

Komplettdruck des Formular-Bündels

Keine weiteren Properties erforderlich

Das komplette Formular-Bündel wird einmal ausgedruckt. Es werden Leerseiten so eingesteuert, dass jedes Einzel-Dokument auf einem neuen Blatt beginnt.

Ausdruck von Einzelseiten des Formularbündels ohne und mit Kopien

PageSelection=1;10,2

InsertEmptyPageBetweenRtfBookmarks=“1“

Die Seite 1 des Formularsbündels wird einmal und Seite 10 dreimal gedruckt.

Durch Setzen der Property „InsertEmptyPageBetweenRtf-Bookmarks“ wird verhindert, dass die Seite 10 auf die Rückseite von Seite 1 gedruckt wird.

Ausdruck auf unterschiedliche Schächte

Variante 1

PaperBin=“BinManual;BinUpper“

PaperBinReset=Bookmarks

Die erste Seite jedes Teil-Dokuments wird auf manuellem Schacht, der Rest auf oberem Schacht gedruckt.

Variante 2

PaperBin=“BinManual;BinUpper“

PaperBinReset=None

Die erste Seite des Formular-Bündels wird auf manuellem Schacht, der Rest auf oberem Schacht gedruckt.

Ausdruck auf unterschiedliche Schächte mit Kopien

PrintCopies2=1

PaperBin=“BinManual;BinUpper“

PaperBinReset=Copies

Das komplette Formular-Bündel wird zweimal gedruckt. Dabei geht die erste Seite jeder Kopie auf den manuellen und die restlichen Seiten auf den oberen Schacht.