Objekt XmlDocument
Das XmlDocument-Objekt repräsentiert das gesamte XML-Dokument
Das XmlDocument-Objekt ist das Stammverzeichnis eines Dokumentbaums, mit dem wir den ersten (oder obersten) Zugriff auf die Dokumentdaten erhalten. Wird für Elementknoten, Textknoten, Kommentare, Verarbeitungsanweisungen usw. nicht außerhalb von XmlDocument verwendet. Das XmlDocument-Objekt bietet auch Methoden zum Erstellen dieser Objekte. XmlNode Objekte stellen eine ownerDocument-Eigenschaft bereit, die sie dem XmlDocument zuordnet, in dem sie erstellt wurden.
Erbe
Konstrukteur
XmlDocument
Erstellen Sie ein XmlDocument-Objekt
1new XmlDocument(String type = "text/xml");
Parameter aufrufen:
- type : Zeichenfolge, geben Sie den Typ des Dokumentobjekts an. Der Standardwert ist "text / xml ". Wenn Sie HTML verarbeiten müssen, müssen Sie "text / html" angeben.
Mitgliedsattribute
inputEncoding
String, gibt die für das Dokument verwendete Codierung zurück (beim Parsen)
1readonly String XmlDocument.inputEncoding;
xmlStandalone
Boolesch, festlegen oder zurückgeben, ob das Dokument eigenständig ist
1Boolean XmlDocument.xmlStandalone;
xmlVersion
Zeichenfolge, Festlegen oder Zurückgeben der XML-Version des Dokuments
1String XmlDocument.xmlVersion;
doctype
XmlDocumentType gibt die Dokumentdokumentation zurück, die sich auf das Dokument bezieht (Dokumenttypdeklaration).
1readonly XmlDocumentType XmlDocument.doctype;
Bei XML-Dokumenten ohne DTD wird null zurückgegeben. Dieses Attribut bietet direkten Zugriff auf das XmlDocumentType Objekt (einen untergeordneten Knoten von XmlDocument).
documentElement
XmlElement gibt den XmlElement des Dokuments zurück
1readonly XmlElement XmlDocument.documentElement;
head
XmlElement gibt den Hauptknoten des HTML-Dokuments zurück, der nur im HTML-Modus gültig ist
1readonly XmlElement XmlDocument.head;
title
String, gibt den Inhalt des Titelknotens des HTML-Dokuments zurück, der nur im HTML-Modus gültig ist
1readonly String XmlDocument.title;
body
XmlElement gibt den Hauptknoten des HTML-Dokuments zurück, der nur im HTML-Modus gültig ist
1readonly XmlElement XmlDocument.body;
nodeType
Ganzzahl, gibt den Knotentyp des Knotens zurück
1readonly Integer XmlDocument.nodeType;
Der Knotentyp verschiedener Objekte gibt unterschiedliche Werte zurück:
- XmlElement : ELEMENT_NODE (1)
- XmlAttr : ATTRIBUTE_NODE (2)
- XmlText : TEXT_NODE (3)
- XmlCDATASection : CDATA_SECTION_NODE (4)
- XmlProcessingInstruction : PROCESSING_INSTRUCTION_NODE (7)
- XmlComment : COMMENT_NODE (8)
- XmlDocument : DOCUMENT_NODE (9)
- XmlDocumentType : DOCUMENT_TYPE_NODE (10)
nodeName
String, gibt den Namen des Knotens entsprechend seinem Typ zurück
1readonly String XmlDocument.nodeName;
Der Knotenname verschiedener Objekte gibt unterschiedliche Werte zurück:
- XmlElement : Elementname
- XmlAttr : Attributname
- XmlText : #text
- XmlCDATASection : # cdata-section
- XmlProcessingInstruction : XmlProcessingInstruction das angegebene Ziel zurück
- XmlComment : #comment
- XmlDocument : #document
- XmlDocumentType : Doctype-Name
nodeValue
String, gibt den Namen des Knotens entsprechend seinem Typ zurück
1String XmlDocument.nodeValue;
Der Knotenname verschiedener Objekte gibt unterschiedliche Werte zurück:
- XmlElement : null
- XmlAttr : Der Wert des Attributs
- XmlText : Der Inhalt des Knotens
- XmlCDATASection : Der Inhalt des Knotens
- XmlProcessingInstruction : XmlProcessingInstruction die angegebenen Inhaltsdaten zurück
- XmlComment : Kommentartext
- XmlDocument : null
- XmlDocumentType : null
ownerDocument
XmlDocument, gibt das Stammelement des Knotens zurück (XmlDocument-Objekt)
1readonly XmlDocument XmlDocument.ownerDocument;
parentNode
XmlNode kann den übergeordneten Knoten eines Knotens zurückgeben
1readonly XmlNode XmlDocument.parentNode;
childNodes
XmlNodeList gibt die Knotenliste der XmlNodeList Knoten des angegebenen Knotens zurück
1readonly XmlNodeList XmlDocument.childNodes;
firstChild
XmlNode gibt den ersten XmlNode Knoten des Knotens zurück
1readonly XmlNode XmlDocument.firstChild;
lastChild
XmlNode gibt den letzten XmlNode Knoten des Knotens zurück
1readonly XmlNode XmlDocument.lastChild;
previousSibling
XmlNode gibt den Knoten unmittelbar vor einem Knoten (auf derselben XmlNode ) zurück. Wenn kein solcher Knoten vorhanden ist, gibt diese Eigenschaft null zurück
1readonly XmlNode XmlDocument.previousSibling;
nextSibling
XmlNode gibt den Knoten unmittelbar nach einem Element (in derselben XmlNode ) zurück. Wenn kein solcher Knoten vorhanden ist, gibt die Eigenschaft null zurück
1readonly XmlNode XmlDocument.nextSibling;
Mitgliedsfunktion
load
Erstellen Sie das Dokument durch Parsen einer XML / HTML-Zeichenfolge, unterstützt keine Mehrsprachigkeit
1XmlDocument.load(String source);
Parameter aufrufen:
- source : String, der zu analysierende XML / HTML-Text, abhängig von der Art des Dokuments, als es erstellt wurde
Erstellen Sie das Dokument, indem Sie eine binäre XML / HTML-Zeichenfolge analysieren und sie automatisch entsprechend der Sprache konvertieren
1XmlDocument.load(Buffer source);
Parameter aufrufen:
- source : Buffer , der zu analysierende XML / HTML-Text, hängt von der Art des Dokuments ab, als es erstellt wurde
getElementsByTagName
Gibt eine Knotenliste aller Elemente mit dem angegebenen Namen zurück
1XmlNodeList XmlDocument.getElementsByTagName(String tagName);
Parameter aufrufen:
- tagName : String, der Name des abzurufenden Tags. Der Wert "*" entspricht allen Tags
Ergebnis zurückgeben:
- XmlNodeList , eine Sammlung von XmlNodeList von XmlElement Knoten mit angegebenen Tags in der Dokumentstruktur. Die Reihenfolge der zurückgegebenen Elementknoten ist die Reihenfolge, in der sie im Quelldokument angezeigt werden.
Diese Methode gibt ein XmlNodeList Objekt zurück (das als schreibgeschütztes Array verarbeitet werden kann), das alle XmlElement Knoten im Dokument mit dem angegebenen Tag-Namen speichert. Die Reihenfolge, in der sie gespeichert werden, ist die Reihenfolge, in der sie im Quelldokument XmlElement werden. XmlNodeList Objekt ist "live". Wenn also ein Element mit einem angegebenen Tag-Namen im Dokument hinzugefügt oder gelöscht wird, wird sein Inhalt bei Bedarf automatisch aktualisiert.
getElementsByTagNameNS
Gibt eine Liste von Knoten mit allen Elementen des angegebenen Namespace und Namens zurück
1
2XmlNodeList XmlDocument.getElementsByTagNameNS(String namespaceURI,
String localName);
Parameter aufrufen:
- namespaceURI : String, gibt den abzurufenden Namespace-URI an. Der Wert "*" kann mit allen Tags übereinstimmen
- localName : String, der abzurufende Labelname. Der Wert "*" entspricht allen Tags
Ergebnis zurückgeben:
- XmlNodeList , eine Sammlung von XmlNodeList von XmlElement Knoten mit angegebenen Tags in der Dokumentstruktur. Die Reihenfolge der zurückgegebenen Elementknoten ist die Reihenfolge, in der sie im Quelldokument angezeigt werden.
Diese Methode ähnelt der Methode getElementsByTagName (), mit der Ausnahme, dass Elemente basierend auf dem Namespace und dem Namen abgerufen werden.
getElementById
Gibt das Element mit dem angegebenen ID-Attribut zurück
1XmlElement XmlDocument.getElementById(String id);
Parameter aufrufen:
- id : String, ID, die abgerufen werden soll
Ergebnis zurückgeben:
- XmlElement , der XmlElement Knoten mit dem angegebenen ID-Attribut im Knotenbaum
Diese Methode durchläuft die XmlElement Knoten des Dokuments und gibt ein XmlElement , das das erste Dokumentelement mit dem angegebenen ID-Attribut darstellt. .
getElementsByClassName
Gibt eine Knotenliste aller Elemente mit dem angegebenen Klassennamen zurück
1XmlNodeList XmlDocument.getElementsByClassName(String className);
Parameter aufrufen:
- className : String, der Name der Klasse, die abgerufen werden soll
Ergebnis zurückgeben:
- XmlNodeList , eine XmlNodeList Auflistung von XmlElement Knoten mit dem angegebenen Klassennamen in der Dokumentstruktur. Die Reihenfolge der zurückgegebenen Elementknoten ist die Reihenfolge, in der sie im Quelldokument angezeigt werden.
Diese Methode gibt ein XmlNodeList Objekt zurück (das als schreibgeschütztes Array verarbeitet werden kann), in dem alle XmlElement Knoten mit dem angegebenen Klassennamen im Dokument gespeichert sind. Die Reihenfolge, in der sie gespeichert werden, entspricht der Reihenfolge, in der sie im Quelldokument XmlElement werden. XmlNodeList Objekt ist "live". Wenn also ein Element mit einem angegebenen Tag-Namen im Dokument hinzugefügt oder gelöscht wird, wird sein Inhalt bei Bedarf automatisch aktualisiert.
createElement
Elementknoten erstellen
1XmlElement XmlDocument.createElement(String tagName);
Parameter aufrufen:
- tagName : String, gibt den angegebenen Namen des Elementknotens an
Ergebnis zurückgeben:
- XmlElement gibt den neu erstellten XmlElement Knoten mit dem angegebenen Tag-Namen zurück
createElementNS
Erstellen Sie einen Elementknoten mit dem angegebenen Namespace
1
2XmlElement XmlDocument.createElementNS(String namespaceURI,
String qualifiedName);
Parameter aufrufen:
- namespaceURI : String, gibt den Namespace-URI des Elementknotens an
- qualifiedName Name: String, der angegebene Name des angegebenen Elementknotens
Ergebnis zurückgeben:
- XmlElement gibt den neu erstellten XmlElement Knoten mit dem angegebenen Tag-Namen zurück
createTextNode
Erstellen Sie einen Textknoten
1XmlText XmlDocument.createTextNode(String data);
Parameter aufrufen:
- data : String, geben Sie den Text dieses Knotens an
Ergebnis zurückgeben:
createComment
Kommentarknoten erstellen
1XmlComment XmlDocument.createComment(String data);
Parameter aufrufen:
- data : String, geben Sie den Kommentartext dieses Knotens an
Ergebnis zurückgeben:
- XmlComment gibt den neu erstellten XmlComment Knoten zurück. Der Kommentartext enthält die angegebenen Daten
createCDATASection
Erstellen Sie den XmlCDATASection Knoten
1XmlCDATASection XmlDocument.createCDATASection(String data);
Parameter aufrufen:
- data : String, geben Sie diesen Knoten an, um CDATA-Daten anzugeben
Ergebnis zurückgeben:
- XmlCDATASection gibt den neu erstellten XmlCDATASection Knoten zurück. Der Inhalt sind die angegebenen Daten
createProcessingInstruction
Erstellen Sie den XmlProcessingInstruction Knoten
1
2XmlProcessingInstruction XmlDocument.createProcessingInstruction(String target,
String data);
Parameter aufrufen:
- target : String, geben Sie das Ziel der Verarbeitungsanweisung an
- data : String, geben Sie den Inhaltstext der Verarbeitungsanweisung an
Ergebnis zurückgeben:
- XmlProcessingInstruction , der neu erstellte ProcessingInstruction-Knoten
hasChildNodes
Fragen Sie ab, ob untergeordnete Knoten vorhanden sind
1Boolean XmlDocument.hasChildNodes();
Ergebnis zurückgeben:
- Boolean , return true, wenn untergeordnete Knoten vorhanden sind, andernfalls false
normalize
Füge benachbarte Textknoten zusammen und lösche leere Textknoten
1XmlDocument.normalize();
Diese Methode durchläuft alle untergeordneten Knoten des aktuellen Knotens und normalisiert das Dokument, indem der leere Textknoten gelöscht und alle benachbarten Textknoten zusammengeführt werden. Diese Methode ist nützlich, um die Struktur des Dokumentbaums nach dem Einfügen oder Löschen von Knoten zu vereinfachen.
cloneNode
Erstellen Sie eine genaue Kopie des angegebenen Knotens
1XmlNode XmlDocument.cloneNode(Boolean deep = true);
Parameter aufrufen:
- deep : Boolean, ob tief kopiert werden soll. Wenn true, klont der geklonte Knoten alle untergeordneten Knoten des ursprünglichen Knotens
Ergebnis zurückgeben:
- XmlNode , geben Sie den kopierten Knoten zurück
Diese Methode kopiert eine Kopie des Knotens, der sie aufgerufen hat, und gibt sie zurück. Wenn der an ihn übergebene Parameter wahr ist, werden auch alle Nachkommen des aktuellen Knotens rekursiv kopiert. Andernfalls wird nur der aktuelle Knoten kopiert. Der zurückgegebene Knoten gehört nicht zum Dokumentbaum, und seine Eigenschaft parentNode ist null. Wenn der Elementknoten kopiert wird, werden alle seine Attribute kopiert.
lookupPrefix
Gibt das Präfix zurück, das dem angegebenen Namespace-URI auf dem aktuellen Knoten entspricht
1String XmlDocument.lookupPrefix(String namespaceURI);
Parameter aufrufen:
- namespaceURI : String, geben Sie den passenden Namespace-URI an
Ergebnis zurückgeben:
- String , gibt das übereinstimmende Präfix zurück und gibt null zurück, wenn es nicht übereinstimmt
lookupNamespaceURI
Gibt den Namespace-URI zurück, der dem angegebenen Präfix auf dem aktuellen Knoten entspricht
1String XmlDocument.lookupNamespaceURI(String prefix);
Parameter aufrufen:
- prefix : String, geben Sie das passende Präfix an
Ergebnis zurückgeben:
- String , gibt den übereinstimmenden Namespace-URI zurück und gibt null zurück, wenn er nicht übereinstimmt
insertBefore
Fügen Sie einen neuen untergeordneten Knoten vor dem vorhandenen untergeordneten Knoten ein
1
2XmlNode XmlDocument.insertBefore(XmlNode newChild,
XmlNode refChild);
Parameter aufrufen:
- newChild : XmlNode , XmlNode einen neuen Knoten ein
- refChild : XmlNode , XmlNode einen neuen Knoten vor diesem Knoten ein
Ergebnis zurückgeben:
Wenn newChild bereits im Dokumentbaum vorhanden ist, wird es aus dem Dokumentbaum gelöscht und an seiner neuen Position wieder eingefügt. Knoten aus einem Dokument (oder von einem Dokument erstellte Knoten) können nicht in ein anderes Dokument eingefügt werden. Mit anderen Worten, die ownerDocument-Eigenschaft von newChild muss mit der ownerDocument-Eigenschaft des aktuellen Knotens identisch sein.
insertAfter
Fügen Sie nach dem vorhandenen untergeordneten Knoten einen neuen untergeordneten Knoten ein
1
2XmlNode XmlDocument.insertAfter(XmlNode newChild,
XmlNode refChild);
Parameter aufrufen:
- newChild : XmlNode , XmlNode einen neuen Knoten ein
- refChild : XmlNode , XmlNode nach diesem Knoten einen neuen Knoten ein
Ergebnis zurückgeben:
Wenn newChild bereits im Dokumentbaum vorhanden ist, wird es aus dem Dokumentbaum gelöscht und an seiner neuen Position wieder eingefügt. Knoten aus einem Dokument (oder von einem Dokument erstellte Knoten) können nicht in ein anderes Dokument eingefügt werden. Mit anderen Worten, die ownerDocument-Eigenschaft von newChild muss mit der ownerDocument-Eigenschaft des aktuellen Knotens identisch sein.
appendChild
Fügen Sie am Ende der Liste der untergeordneten Knoten des Knotens einen neuen untergeordneten Knoten hinzu
1XmlNode XmlDocument.appendChild(XmlNode newChild);
Parameter aufrufen:
- newChild : XmlNode , geben Sie den hinzugefügten Knoten an
Ergebnis zurückgeben:
Wenn newChild bereits im Dokumentbaum vorhanden ist, wird es aus dem Dokumentbaum gelöscht und an seiner neuen Position wieder eingefügt. Knoten aus einem Dokument (oder von einem Dokument erstellte Knoten) können nicht in ein anderes Dokument eingefügt werden. Mit anderen Worten, die ownerDocument-Eigenschaft von newChild muss mit der ownerDocument-Eigenschaft des aktuellen Knotens identisch sein.
replaceChild
Ersetzen Sie einen untergeordneten Knoten durch einen anderen
1
2XmlNode XmlDocument.replaceChild(XmlNode newChild,
XmlNode oldChild);
Parameter aufrufen:
- newChild : XmlNode , geben Sie einen neuen Knoten an
- oldChild : XmlNode , geben Sie den zu ersetzenden Knoten an
Ergebnis zurückgeben:
- XmlNode : Wenn die Ersetzung erfolgreich ist, kann diese Methode den ersetzten Knoten zurückgeben. Wenn die Ersetzung fehlschlägt, wird null zurückgegeben
Wenn newChild bereits im Dokumentbaum vorhanden ist, wird es aus dem Dokumentbaum gelöscht und an seiner neuen Position wieder eingefügt. Knoten aus einem Dokument (oder von einem Dokument erstellte Knoten) können nicht in ein anderes Dokument eingefügt werden. Mit anderen Worten, die ownerDocument-Eigenschaft von newChild muss mit der ownerDocument-Eigenschaft des aktuellen Knotens identisch sein.
removeChild
Entfernen Sie einen Knoten aus der Liste der untergeordneten Knoten
1XmlNode XmlDocument.removeChild(XmlNode oldChild);
Parameter aufrufen:
- oldChild : XmlNode , geben Sie den zu löschenden Knoten an
Ergebnis zurückgeben:
- XmlNode : Wenn das Löschen erfolgreich ist, kann diese Methode den gelöschten Knoten zurückgeben. Wenn dies fehlschlägt, wird null zurückgegeben
toString
Gibt die Zeichenfolgendarstellung des Objekts zurück, gibt im Allgemeinen "[Native Object]" zurück. Das Objekt kann gemäß seinen eigenen Merkmalen erneut implementiert werden
1String XmlDocument.toString();
Ergebnis zurückgeben:
- String , gibt die String-Darstellung des Objekts zurück
toJSON
Gibt die Darstellung des Objekts im JSON-Format zurück und gibt im Allgemeinen eine Sammlung lesbarer Attribute zurück, die vom Objekt definiert wurden
1Value XmlDocument.toJSON(String key = "");
Parameter aufrufen:
- key : String, unbenutzt
Ergebnis zurückgeben:
- Value , gibt einen Wert zurück, der JSON serialisierbar enthält