PDFlib API-Referenz 9.0.2

Tabelle 2.11 Optionen für PDF_poca_new( ), PDF_poca_insert( ) und PDF_poca_remove( )
Option
type 1
value 1
values 1
Beschreibung
(Schlüsselwort; erforderlich außer für Stream-Container ohne die Option key) Gibt den Typ des eingefügten
Objekts an: array, boolean, dict, integer, name, float, stream, string, percentage, color
Die folgenden Typen sind nicht erlaubt, wenn der Container mit usage=dpm erzeugt wurde: name (verwenden
Sie stattdessen type=string), stream
Die folgenden Typen sind nur erlaubt, wenn der Container mit usage=blocks erzeugt wurde: color,
percentage
(Datentyp gemäß der Option type; genau eine der Optionen value und values muss übergeben werden)
Gibt den Wert des eingefügten Objekts abhängig vom Container-Typ und der Option type an:
Bei Array- und Dictionary-Containern:
Bei type=boolean muss der Wert den Datentyp string haben und einen der Strings true oder false enthalten.
Bei type=string oder name muss der Wert den Datentyp Hypertext string haben und muss das Ziel direkt
enthalten. Werte für type=name sind in der UTF-8-Darstellung auf 127 Bytes begrenzt und dürfen keinen
führenden Schrägstrich ’/’ enthalten.
Bei type=integer muss der Wert den Datentyp integer haben und muss das Ziel direkt enthalten.
Bei type=float muss der Wert den Datentyp float oder integer haben und muss das Ziel direkt enthalten.
Bei type=array, dict oder stream muss der Wert den Datentyp POCA-Container-Handle haben (d.h. mit
PDF_poca_new( ) erstellt worden sein) und muss den eingefügten Container angeben. Das eingefügte
Objekt muss mit der gleichen Option usage erstellt worden sein wie der Container.
Bei type=percentage muss der Wert den Datentyp number haben. Er wird als Prozentwert interpretiert
und muss ein Prozentzeichen enthalten (z.B. 50%). Er wird als Block-Datentyp percentage in die PDF-Ausgabedatei
geschrieben.
Bei type=color muss der Wert den Datentyp color haben (siehe Tabelle 1.2). Er wird als Block-Datentyp
percentage in die PDF-Ausgabedatei geschrieben. Die folgenden Farbraum-Schlüsselwörter sind nicht erlaubt:
iccbased, iccbasedgray, iccbasedrgb, iccbasedcmyk, pattern
Um beliebige Strings mit dieser Option zu übergeben, empfehlen wir die Syntax für Optionslisten, siehe
Abschnitt »Nicht eingeschlossene String-Werte in Optionslisten«, Seite 10.
(Liste von einem oder mehreren Werten gemäß der Option type; nur für Container mit type=array;
genau eine der Optionen value und values muss übergeben werden) Gibt einen oder mehrere Werte
desselben Typs an, die an der Position in dem Array eingefügt werden, die in der Option index festgelegt
wurde. Siehe die Option value bezüglich der Bedingungen für bestimmte Typen. Enthält die angegebene
Liste nur ein einziges Element, ist das Ergebnis äquivalent zu der Option value. Enthält die Liste mehr als
ein Element, werden alle Elemente aus der Liste nacheinander in das Array eingefügt, gegebenenfalls
werden dabei bestehende Elemente überschrieben. Das Array wächst entsprechend, um alle Elemente in
der angegebenen Liste aufzunehmen.
1. Nur für PDF_poca_new( ) und PDF_poca_insert( )
C++ Java C# void poca_remove(int container, String optlist))
Perl PHP poca_remove(int container, string optlist)
C void PDF_poca_remove(PDF *p, int container, const char *optlist)
Entfernt ein einfaches oder ein Container-Objekt aus einem PDF-Container-Objekt.
container Gültiger Handle für POCA-Dictionary oder für ein Array, die mit PDF_poca_
new( ) erstellt wurden. Eingefrorene Container sind nicht erlaubt, da sie nicht mehr modifiziert
werden können (siehe »Objekttypen und eingefrorene Objekte«, Seite 38).
2.6 PDF Object Creation API (POCA) 41