LitDev 1.2.24.0 DE
http://litdev.uk/LitDev.De.html Extension API
LDxml
Methoden zur Erstellung, Bearbeitung sowie Parser Methoden für Auswertung und Vergleich von Xml Dateien.
example other-samples\LDxml.sb
AddNode(name,attributes,text,location)
Fügt einen neuen Knoten ein.
Der aktuelle Knoten bleibt unverändert und wird nicht als neuer Knoten aktualisiert.
name Der Elementname für den neuen Knoten.
attributes Ein Array mit Attributen (Werte indexiert durch Attributname) für den neuen Knoten oder "".
text Der innere Text für den neuen Knoten oder "".
location Einfügeposition für den neuen Knoten:
"Append" am Ende aller Unterknoten im aktuellen Knoten
"Prepend" am Beginn der Unterknoten im aktuellen Knoten
"Before" vor dem aktuellen Knoten
"After" nach dem aktuellen Knoten
returns "SUCCESS" bei Erfolg, sonst "FAILED".
Attributes
Ermittelt die Attribute für den aktuellen Knoten als Array mit den Attribut-Textwerten (indexiert durch die Attributnamen, zB. "name=T:LitDev.LDxml;..."), sonst "".
AttributesCount
Ermittelt die Anzahl der Attribute für den aktuellen Knoten.
ChildrenCount
Ermittelt die Anzahl der Unterknoten innerhalb des aktuellen Knoten.
FirstChild()
Verschiebt den aktuellen Knoten an den ersten Unterknoten, falls vorhanden.
returns "SUCCESS" bei Erfolg, sonst "FAILED".
FirstNode()
Setzt den aktuellen Knoten als ersten Knoten im Xml Dokument.
returns "SUCCESS" bei Erfolg, sonst "FAILED".
FromArray(array)
Erstellt ein neues Xml Dokument von einer Array Definition. Umkehrung der 'ToArray' Methode (Intern: XMLDoc#+1).
array Ein SB Array im korrekten Format (Arrayformat wie s. 'ToArray').
returns Der Name des neuen Xml Dokuments bei Erfolg, sonst "FAILED".
LastChild()
Verschiebt den aktuellen Knoten an den letzten Unterknoten, falls vorhanden.
returns "SUCCESS" bei Erfolg, sonst "FAILED".
NextSibling()
Verschiebt den aktuellen Knoten an den nächst folgenden Nachbarknoten, falls vorhanden.
returns "SUCCESS" bei Erfolg, sonst "FAILED".
NodeInnerText
Ermittelt den gesamten inneren Text im aktuellen Knoten und allen Unterknoten, sonst "".
NodeName
Ermittelt den Elementname des aktuellen Knoten (zB. code, doc, example, member, note, param, remarks, returns, summary, usw.), sonst "".
NodeType
Ermittelt den Typ des aktuellen Knoten (einer vieler Typen, meist jedoch "Element" oder "Text").
Open(fileName)
Öffnet eine bestehende Xml Datei (Intern: XMLDoc#).
Ist vor allen weiteren 'LDxml' Methoden aufzurufen.
fileName Der volle Pfad der zu öffnenden Xml Datei. Bei "" wird ein neues Xml Leerdokument erstellt.
returns Der Name des Xml Dokuments (Intern: XMLDoc#+1) bei Erfolg, sonst "FAILED".
Parent()
Verschiebt den aktuellen Knoten an den Elternknoten, falls vorhanden.
returns "SUCCESS" bei Erfolg, sonst "FAILED".
PreviousSibling()
Verschiebt den aktuellen Knoten an den vorhergehenden Nachbarknoten, falls vorhanden.
returns "SUCCESS" bei Erfolg, sonst "FAILED".
RemoveNode()
Entfernt den aktuellen Knoten incl. Unterknoten.
Der aktuelle Knoten wird zurückgesetzt auf den vorhergehenden Nachbarknoten bzw. Elternknoten, wenn kein vorhergehender Nachbarknoten existiert.
returns Der neue aktuelle Knoten ("SIBLING" bzw. "PARENT") bei Erfolg, sonst "FAILED".
RenameRoot(name)
Umbenennen des root Elementes (Basiselement, Standard: "root").
name Der neue Name für das root Element.
returns "SUCCESS" bei Erfolg, sonst "FAILED".
Save(fileName)
Speichert das aktuelle Xml Dokument in eine Datei.
fileName Der volle Pfad der zu speichernden Xml Datei.
returns "SUCCESS" bei Erfolg, sonst "FAILED".
Switch(docName)
Umschalten zu einem anderen geladenen Xml Dokument. Der aktuelle Knoten wird für jedes Dokument beibehalten.
docName Der Name des Xml Dokuments (Rückgabewert von 'Open', Intern: XMLDoc#).
returns "SUCCESS" bei Erfolg, sonst "FAILED".
ToArray()
Konvertiert das aktuelle Xml Dokument zu einem SB Array (Umkehrung s. 'FromArray').
Die Struktur und Tiefe des Arrays können dabei ziemlich komplex werden.
Jeder Knoten besitzt optionale Arrays "Attributes" und "Children" oder "Data".
Sind Unterknoten vorhanden, so werden diese erst nach Nummer indexiert (zur Unterscheidung mehrerer gleichnamiger Unterknoten).
returns Ein (mehrdimensionaler) SB Array bei Erfolg, sonst "FAILED".
View()
Anzeige des aktuellen Xml Dokuments in eigenem XMLViewer-Fenster (zB. Debugging).
GraphicsWindow muß initialisiert/geöffnet sein bzw. aus einer Ereignis-Sub aufrufen (STA-Thread).
Markierter Text kopierbar mit Strg+C.