Methoden zur Verwendung von Objekten der Klasse Element.

Methoden zur Verwendung von Objekten der Klasse Element.

static Element element::alloc(
  int id = 0,
  int id2 = 0,
  int id3 = 0,
  char* stringid = "")

Erzeuge ein neues Element vom Typ Element. Das Objekt muss mit element::release wieder gelöscht werden.

Name Typ Default Beschreibung
Return Element   Ein neues Objekt von Typ Element
id int 0 Erster Zahlenwert des Elements oder 0
id2 int 0 Zweiter Zahlenwert des Elements oder 0
id3 int 0 Dritter Zahlenwert des Elements oder 0
stringid String oder char* "" StringID des Elements oder ""
Element		str	= element::alloc (1);
Element		str	= element::alloc (1, 0, 0, "meine StringID");

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

copy
release
set_classid
set_templateid
set_formatstring
comet.element.create

static void element::release(Element id)

Löschen eines mit element::alloc erzeugten Element-Objektes

Name Typ Default Beschreibung
str Element - Lösche dieses Objekt aus dem Speicher
Element		id	= element::alloc ();
 	:
 	:
element::release (id);

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

static Element element::copy(Element e1, Element e2)

Kopiere den Inhalt eines Elements in ein anderes Element. Der Inhalt von e2 wird in e1 kopiert.

Name Typ Default Beschreibung
Return Element   Der Parameter e1 wird zurückgegeben.
e1 Element - dieses Objekt soll geändert werden.
e2 Element - Für die Änderung sollen sollen diese Werte verwdendet werden

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

static int element::id(Element element)

Hole die erste Zahl eines Elements.

Name Typ Default Beschreibung
Return int   Erste Zahl eines gegebenen Objekts vom Typ Element
element Element - Gültiges Objekt vom Typ Element

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.getID

static int element::id2(Element element)

Hole die zweite Zahl eines Elements.

Name Typ Default Beschreibung
Return int   Zweite Zahl eines gegebenen Objekts vom Typ Element
element Element - Gültiges Objekt vom Typ Element

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.getID

static int element::id3(Element element)

Hole die dritte Zahl eines Elements.

Name Typ Default Beschreibung
Return int   Dritte Zahl eines gegebenen Objekts vom Typ Element
element Element - Gültiges Objekt vom Typ Element

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.getID

static char* element::stringid(Element element)

Hole die StringID eines Elements.

Name Typ Default Beschreibung
Return char*   StringID eines gegebenen Objekts vom Typ Element

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

element Element - Gültiges Objekt vom Typ Element

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.getID

static int element::templateid(Element element)

Hole die Template Id eines Elements

Name Typ Default Beschreibung
Return int   Template Id eines Elements vom Typ Element
element Element - Gültiges Objekt vom Typ Element

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.getTemplateID

static int element::classid(Element element)

Hole die Class Id eines Elements

Name Typ Default Beschreibung
Return int   Class Id eines Elements vom Typ Element
element Element - Gültiges Objekt vom Typ Element

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.getClassID

static char* element::formatstring(Element element)

Hole den Format-String eines Elements.

Name Typ Default Beschreibung
Return char*   Formatstring eines gegebenen Objekts vom Typ Element

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

element Element - Gültiges Objekt vom Typ Element

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.getFormatString

static ItemRef element::masterframe(Element element)

Hole den Rahmen des wiederholenden Elementes, durch den ein Element aufgebaut wurde.

Name Typ Default Beschreibung
Return ItemRef   Hauptrahmen eines wiederholten Elementes. Der Aufruf hat nur für Elemente aus Listen, die mit elementlist::get_area_built_elements gefüllt wurden, einen Wert ungleich 0.
element Element - Gültiges Objekt vom Typ Element

Ein Beispiel für die Funktion finden Sie hier.

-

Version 4.1 R21400

priint:comet InDesign® Plug-Ins, comet_pdf

elementlist::get_area_built_elements
comet.CElement.getMasterFrame

static ItemList element::frames(Element element)

Hole die Liste aller Rahmen eines wiederholten Elementes.

Name Typ Default Beschreibung
Return ItemList   Liste der Rahmen eines wiederholten Elementes. Der Aufruf hat nur für Elemente aus Listen, die mit elementlist::get_area_built_elements gefüllt wurden, einen Wert ungleich 0.
element Element - Gültiges Objekt vom Typ Element

Ein Beispiel für die Funktion finden Sie hier.

-

Version 4.1 R21400

priint:comet InDesign® Plug-Ins, comet_pdf

elementlist::get_area_built_elements
comet.CElement.getFrames

static ItemList element::ordernumber(Element element)

Hole die Ordnungsnummer eines wiederholten Elementes. Ordnungsnummern werden standardmäßig in 10er Schritten vergeben.

Name Typ Default Beschreibung
Return int   Ornungsnummer der wiederholten Elementes Der Aufruf hat nur für Elemente aus Listen, die mit elementlist::get_area_built_elements gefüllt wurden, einen Wert ungleich -1.
element Element - Gültiges Objekt vom Typ Element

Ein Beispiel für die Funktion finden Sie hier.

-

Version 4.1 R21400

priint:comet InDesign® Plug-Ins, comet_pdf

elementlist::get_area_built_elements
comet.CElement.getOrderNumber

static int element::set_id(Element element, int i)

Setze die erste Zahl eines Elements.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
element Element - Gültiges Objekt vom Typ Element
i int - Neuer Wert für die erste ID-Zahl

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.setID

static int element::set_id2(Element element, int i)

Setze die zweite Zahl eines Elements.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
element Element - Gültiges Objekt vom Typ Element
i int - Neuer Wert für die zweite ID-Zahl

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.setID

static int element::set_id3(Element element, int i)

Setze die dritte Zahl eines Elements.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
element Element - Gültiges Objekt vom Typ Element
i int - Neuer Wert für die dritte ID-Zahl

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.setID

static int element::set_stringid(Element element, char* si)

Setze die StringID eines Elements.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
element Element - Gültiges Objekt vom Typ Element
si String oder char* - Neuer Wert für die StringID

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.setID

static int element::set_templateid(Element element, int templateId)

Setze die Template-Id eines Elements.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
element Element - Gültiges Objekt vom Typ Element
templateId int - Neuer Wert für die Template-Id  

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.setTemplateID

static int element::set_classid(Element element, int classId)

Setze die Class-Id eines Elements.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
element Element - Gültiges Objekt vom Typ Element
classId int - Neuer Wert für die Class-Id  

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.setClassID

static int element::set_formatstring(Element element, char* fs)

Setze den Format String eines Elements.

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
element Element - Gültiges Objekt vom Typ Element
fs String oder char* - Neuer Wert für den Format-String wiederholter Elemente

Version 4.1.0 R19232

priint:comet InDesign® Plug-Ins, comet_pdf

comet.CElement.setFormatString

static char* element::record_id(char* stringId)

Ermittle den RecordID Part einer StringID.

Name Typ Default Beschreibung
Return char *   RecordID part einer StringID.

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

stringId String oder char* - StringID in PublishingServer Schema

Version 4.1.0 R19232

Verfügbarkeit:
Comet-Plug-Ins, comet_pdf

static char* element::group_id(char* stringId)

Ermittle den GroupID Part einer StringID.

Name Typ Default Beschreibung
Return char *   GroupID part einer StringID

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

stringId String oder char* - StringID im PublishingServer Schema

Version 4.1.0 R19232

Verfügbarkeit:
Comet-Plug-Ins, comet_pdf

static char* element::entity_id(char* stringId)

Ermittle den EntityID Part einer StringID.

Name Typ Default Beschreibung
Return char *   EntityID part einer StringID.

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

stringId String oder char* - StringID im PublishingServer Schema

Version 4.1.0 R19232

Verfügbarkeit:
Comet-Plug-Ins, comet_pdf

static char* element::entity_class(char* stringId)

Ermittle den EntityClass Part einer StringID.

Name Typ Default Beschreibung
Return char *   EntityClass part einer StringID.

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

stringId String oder char* - StringID im PublishingServer Schema

Version 4.1.0 R19232

Verfügbarkeit:
Comet-Plug-Ins, comet_pdf

static char* element::parent_record_id(char* stringId)

Ermittle den Parent RecordID Part einer StringID.

Name Typ Default Beschreibung
Return char *   Parent RecordID part einer StringID.

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

stringId String oder char* - StringID im PublishingServer Schema

Version 4.1.0 R19232

Verfügbarkeit:
Comet-Plug-Ins, comet_pdf

static char* element::parent_group_id(char* stringId)

Ermittle den Parent GroupID Part einer StringID.

Name Typ Default Beschreibung
Return char *   Parent GroupID part einer StringID.

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

stringId String oder char* - StringID im PublishingServer Schema

Version 4.1.0 R19232

Verfügbarkeit:
Comet-Plug-Ins, comet_pdf

static char* element::parent_entity_id(char* stringId)

Ermittle den Parent EntityID Part einer StringID.

Name Typ Default Beschreibung
Return char *   Parent EntityID part einer StringID.

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

stringId String oder char* - StringID im PublishingServer Schema

Version 4.1.0 R19232

Verfügbarkeit:
Comet-Plug-Ins, comet_pdf

static char* element::parent_entity_class(char* stringId)

Ermittle den Parent EntityClass Part einer StringID.

Name Typ Default Beschreibung
Return char *   Parent EntityClass part einer StringID.

Der Rückgabewert darf nicht verändert werden und wird bei folgenden Aufrufen der Funktion überschrieben. Hier finden Sie Informationen zu readonly-Rückgaben von Funktionen.

stringId String oder char* - StringID im PublishingServer Schema

Version 4.1.0 R19232

Verfügbarkeit:
Comet-Plug-Ins, comet_pdf

static char* element::to_xml(Element object, char* rootElementName = "element")

Generiere die XML Struktur eines Element-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.
object Element - Object
rootElementName String oder char* element Name des Root-Elements

Version 4.1.0 R19232
comet.publication.toXMLElement

static Element element::from_xml(char* xml)

Generiere eine Element-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 Element   Objekt vom Typ Element. Dieses Objekt muss mit element::release wieder freigegeben werden.
xml String oder char* - xml string

Version 4.1.0 R19232
comet.publication.fromXMLElement

Seit
Version 4.1.0 R19232

Alphabetic index HTML hierarchy of classes or Java