combit List & Label - Programmierer-Referenz - combit GmbH

Verwendung der DOM-API (ab Professional Edition)
5.1. Grundlagen
Jedes "Objekt" innerhalb einer Projektdatei hat ein eigenes Handle ("DOM-Handle"). Die
Funktionen des DOM-API verwenden dieses Handle, um Objekte eindeutig zu identifizieren.
"Objekte" in diesem Sinne sind hierbei alle Designerobjekte, aber auch andere Elemente
wie Hilfslinien, Projektparameter etc.. Der im Lieferumfang befindliche DOM-
Viewer erlaubt einen schnellen Überblick über alle Objekte, deren Wert und weitere
Eigenschaften. Zusätzlich dazu können mit dem Viewer Eigenschaften bzw. Werte geändert
und im Projekt gespeichert werden. Über die Clipboard Funktion kann jedes Objekt
bzw. Eigenschaft zur weiteren Verwendung in die Zwischenablage kopiert werden.
Die für das DOM-API relevanten Funktionen unterteilen sich in 2 Gruppen: zunächst
können Projektdateien geladen, erzeugt und gespeichert werden. Dafür stehen die Funktionen
LlProjectOpen, LlProjectClose und LlProjectSave zur Verfügung. Dabei liefert die
Funktion LlProjectOpen das DOM-Handle für das Projektobjekt zurück. Dieses liefert
dann die Basis für die Verwendung der weiteren Funktionen.
5.1.1. DOM-Funktionen
5.1.1.1. LlDomGetObject
Mit dieser Funktion können vom Projekt-Objekt wichtige Unterobjekte erhalten werden.
Um z.B. die Objektliste zu erhalten, kann
HLLDOMOBJ hProj = LlProjectOpen(hJob, LL_PROJECT_LIST, "c:\\filename.lst",
LL_PRJOPEN_AM_READONLY);
HLLDOMOBJ hObjList;
INT nRet = LlDomGetObject(hProj, "Objects", &hObjList);
verwendet werden. Die weiteren verfügbaren Objekte entsprechen den Einträgen innerhalb
der Baumstruktur im DOM-Viewer: "Layout", "ProjectParameters", "Settings", "Sum-
Vars" und "UserVars". Eine Beschreibung der einzelnen Objekte mit allen Eigenschaften
finden Sie im Referenzkapitel, hier soll das Prinzip der Arbeit mit den DOM-Funktionen
im Vordergrund stehen.
5.1.1.2. LlDomGetSubobjectCount
Dient dazu, die Anzahl der Unterobjekte in der angegebenen Liste abzufragen. Um etwa
die Anzahl der Objekte im Projekt zu erfragen, verwendet man
INT nObjCount;
INT nRet = LlDomGetSubobjectCount(hObjList, &nObjCount);
5.1.1.3. LlDomGetSubobject
Liefert das DOM-Handle des angegebenen Unterobjektes zurück. Parameter sind neben
dem DOM-Handle der Liste der Index (0-basiert) und ein Pointer für die Rückgabe des
Handles. Der Code für ein DOM-Handle auf das erste Objekt in der Projektdatei lautet
68