Listen von Objekten des Typs Element

Listen von Objekten des Typs Element

static ElementList elementlist::alloc()

Erzeuge eine neue Liste von Elementen. Die Liste muss mit elementlist::release wieder gelöscht werden.

Name Typ Default Beschreibung
Return ElementList   Neue Liste für Objekte des Typs Element.

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

static int elementlist::release(ElementList li, int releaseItems = 1)

Lösche eine mit elementlist::alloc erzeugte Liste wieder.

Name Typ Default Beschreibung
li ElementList - Zu löschende Liste
releaseItems int 1 Sollen die Elemente der Liste ebenfalls gelöscht werden?
1 : Ja
0 : Nein, Listeneinträge nicht löschen

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

static int elementlist::length(ElementList li)

Ermittle die Anzahl der Elemente einer Liste

Name Typ Default Beschreibung
Return int   Anzahl der Einträge der Liste
li ElementList - Liste

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

static Element elementlist::get(
  ElementList li,
  int pos,
  int setPos= 0)

Hole das i-te Element der Liste. Listenposition sind 0-basiert, das erste Element hat also die Position 0, das letzte die Position length-1.

Name Typ Default Beschreibung
Return Element   Wert der Liste an der Stelle i oder 0.
li ElementList - Liste, aus der das Element geholt werden soll
pos int - 0-basierte Listenposition
setPos int 0 0 : Listenposition unverändert lassen
1 : Aktuelle Listenposition auf pos setzen
Ist setPos > 0, steht die aktuelle Listenposition auf pos.

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

static int elementlist::append(ElementList li, Element element)

Element an die Liste anfügen. In die Liste wird ein Element mit den Werten des gegebenen Elements eingefügt, nicht das Element selbst. Spätere Änderungen des übergebenen Elements ändern das eigefügte Objekt nicht mehr.

Name Typ Default Beschreibung
Return Element   angefügtes neu erzeugtes Objekt oder 0
li ElementList - Liste, an die angefügt werden soll
⇨ Werte aus einem Element-Objekt übernehmen
element Element - element mit den Werten für das anzufügendene Objekt
⇨ Werte direkt übergeben
id1 int - Erste Zahl des neuen Elements
id2 int - Zweite Zahl des neuen Elements
id3 int - Dritte Zahl des neuen Elements
strid String oder char* - StringID des neuen Elements

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

static int elementlist::insert(
  ElementList li,
  int pos,
  Element val)

Element in die Liste einfügen. In die Liste wird ein Element mit den Werten des gegebenen Elements eingefügt, nicht das Element selbst. Spätere Änderungen des übergebenen Elements ändern das eigefügte Objekt nicht mehr.

Name Typ Default Beschreibung
Return int   eingefügtes neu erzeugtes Objekt oder 0
li ElementList - Liste, in dieeingefügt werden soll
pos int - 0-basierte Einfügestelle
Werte < 0 oder >= length : Anfügen
sonst : An dieser Listenposition einfügen
⇨ Werte aus einem Element-Objekt übernehmen
element Element - element mit den Werten für das einzufügendene Objekt
⇨ Werte direkt übergeben
id1 int - Erste Zahl des neuen Elements
id2 int - Zweite Zahl des neuen Elements
id3 int - Dritte Zahl des neuen Elements
strid String oder char* - StringID des neuen Elements

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

static int elementlist::remove(ElementList li, Element val)

Entferne dieses Objekt aus der Liste .Der Eintrag wird nicht gelöscht. Es wird nur der erste gefundene Eintrag aus der Liste entfernt.

Name Typ Default Beschreibung
Return int   1 : Aktion erfolgreich
0 : sonst
li ElementList - Liste, aus der gelöscht werden soll
val Element - Wert, der aus der Liste entfernt werden soll

Version 4.1.0 R20008

priint:comet InDesign® Plug-Ins, comet_pdf

static Element elementlist::remove_pos(ElementList li, int pos)

Entferne eine Position aus der Liste. Listenposition sind 0-basiert, das erste Element hat also die Position 0, das letzte die Position length-1. Der aus der Liste entfernte Eintrag wird nicht automatisch gelöscht.~

Name Typ Default Beschreibung
Return Element   Aus der Liste entfernter Eintrag oder 0
li ElementList - Liste
pos int - 0-basierte Löschposition

Ein aus einer Elementliste mit elementlist::remove_pos entfernter Eintrag wird nicht automatisch selbst gelöscht. Mit element::release kann der Eintrag gelöscht werden. ACHTUNG: Umgekehrt führt das Löschen einer Element-Variable, die in einer Liste verwendet wird, zu einem nicht definierten Listenobjekt! 

id	= idtypelist::remove_pos (0);
if (id) idtype::release (id);

Version 1.4.1 R 416, 18. Jul 2007 Version 4.1.0 R20008

priint:comet InDesign® Plug-Ins, comet_pdf

static char* elementlist::to_xml(ElementList list, char* rootElementName = "elements")

Generiere die XML Struktur eines ElementList-Objekts.

Wenn Sie über die Verwendung dieser Funktion nachdenken, sind Sie möglicherweise an näheren Informationen zur Interaktion von cscript mit auf dem PubServer als PlugIn bereitgestellten Java-Methoden interessiert. Mehr Informationen dazu finden Sie hier.

Name Typ Default Beschreibung
Return char *   xml string oder 0 bei Fehlern. Der Ergebnisstring ist nur bis zum nächsten Aufruf einer to_xml-Funktion gültig und darf nicht verändert oder freigegeben werden.
list ElementList - Object
rootElementName String oder char* elements Name des Root-Elements

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.publication.toXMLElementList

static ElementList elementlist::from_xml(char* xml)

Generiere eine ElementList-Objekt aus einer XML Struktur.

Wenn Sie über die Verwendung dieser Funktion nachdenken, sind Sie möglicherweise an näheren Informationen zur Interaktion von cscript mit auf dem PubServer als PlugIn bereitgestellten Java-Methoden interessiert. Mehr Informationen dazu finden Sie hier.

Name Typ Default Beschreibung
Return ElementList   Objekt vom Typ ElementList. Dieses Objekt muss mit elementlist::release wieder freigegeben werden.
xml String oder char* - xml string

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.publication.fromXMLElementList

static int elementlist::add_all(
  ElementList target,
  ElementList src,
  int deleteFromSource)

Füge alle Elemente der Liste src in die Liste target ein. Bei deleteFromSource != 0 werden die Elemente aus der Quellliste entfernt (aber nicht freigegeben)

Name Typ Default Beschreibung
Return int   0 oder Fehlercode.
target ElementList - Zielliste  
src ElementList - Quellliste  
deleteFromSource int 0 Elemente aus der Quelliste entfernen

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

static int elementlist::get_area_built_elements(ItemRef frameRef, ElementList target)

Hole alle Elemente, die durch eine wiederholendes Element aufgebaut wurden.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode.
frameRef ItemRef - Rahmen mit einem Platzhalter vom Typ 'Wiederholendes Element'

0 : aktueller Skriptrahmen
target ElementList - Allokierte ElementList für die Ergebnisse. Bestehende Einträge der Liste werden entfernt.

Ein Beispiel für die Funktion finden Sie hier. 

-

Version 4.1 R21400

priint:comet InDesign® Plug-Ins, comet_pdf

element::frames
element::masterframe
comet.CFrame.getBuiltElements

Seit
Version 4.1.0 R19232
Siehe auch
element

Alphabetic index HTML hierarchy of classes or Java