Objekt eingebautes Objekt

Objekt XmlDocument

Das XmlDocument-Objekt repräsentiert das gesamte XML-Dokument

Das XmlDocument-Objekt ist die Wurzel eines Dokumentbaums, der uns den ersten (oder obersten) Zugriff auf die Dokumentdaten ermöglicht. Elementknoten, Textknoten, Kommentare, Verarbeitungsanweisungen usw. können nicht alle außerhalb von XmlDocument existieren, und 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 werden.

Erbe

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>XmlNode|nodeType;nodeName;nodeValue;ownerDocument;parentNode;childNodes;firstChild;lastChild;previousSibling;nextSibling|hasChildNodes();normalize();cloneNode();lookupPrefix();lookupNamespaceURI();insertBefore();insertAfter();appendChild();replaceChild();removeChild()] [<this>XmlDocument|new XmlDocument()|inputEncoding;xmlStandalone;xmlVersion;doctype;documentElement;head;title;body|load();getElementsByTagName();getElementsByTagNameNS();getElementById();getElementsByClassName();createElement();createElementNS();createTextNode();createComment();createCDATASection();createProcessingInstruction()] [object] <:- [XmlNode] [XmlNode] <:- [XmlDocument] XmlDocument new XmlDocument() inputEncoding xmlStandalone xmlVersion doctype documentElement head title body load() getElementsByTagName() getElementsByTagNameNS() getElementById() getElementsByClassName() createElement() createElementNS() createTextNode() createComment() createCDATASection() createProcessingInstruction() XmlNode nodeType nodeName nodeValue ownerDocument parentNode childNodes firstChild lastChild previousSibling nextSibling hasChildNodes() normalize() cloneNode() lookupPrefix() lookupNamespaceURI() insertBefore() insertAfter() appendChild() replaceChild() removeChild() object toString() toJSON()

Konstrukteur

XmlDocument

Konstruieren Sie ein XmlDocument-Objekt

1
new XmlDocument(String type = "text/xml");

Aufrufparameter:

  • type: String, 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)

1
readonly String XmlDocument.inputEncoding;

xmlStandalone

Boolean, setzt oder gibt zurück, ob das Dokument eigenständig ist

1
Boolean XmlDocument.xmlStandalone;

xmlVersion

String, setze oder gebe die XML-Version des Dokuments zurück

1
String XmlDocument.xmlVersion;

doctype

XmlDocumentType, Gibt die zum Dokument gehörige Dokumenttyp-Deklaration zurück (Dokumenttyp-Deklaration)

1
readonly XmlDocumentType XmlDocument.doctype;

Für XML-Dokumente ohne DTD wird null zurückgegeben. Dieses Attribut kann liefernXmlDocumentType Direkter Zugriff auf das Objekt (ein untergeordneter Knoten von XmlDocument).


documentElement

XmlElement, Gibt den Wurzelknoten des Dokuments zurück

1
readonly XmlElement XmlDocument.documentElement;

XmlElement, Gibt den Kopfknoten des HTML-Dokuments zurück, nur gültig im HTML-Modus

1
readonly XmlElement XmlDocument.head;

title

String, gibt den Inhalt des Titelknotens des HTML-Dokuments zurück, nur gültig im HTML-Modus

1
readonly String XmlDocument.title;

body

XmlElement, Gibt den Body-Knoten des HTML-Dokuments zurück, nur gültig im HTML-Modus

1
readonly XmlElement XmlDocument.body;

nodeType

Integer, gibt den Knotentyp des Knotens zurück

1
readonly Integer XmlDocument.nodeType;

Der nodeType verschiedener Objekte gibt unterschiedliche Werte zurück:


nodeName

String, gibt den Namen des Knotens entsprechend seinem Typ zurück

1
readonly String XmlDocument.nodeName;

Der nodeName verschiedener Objekte gibt unterschiedliche Werte zurück:


nodeValue

String, gibt den Namen des Knotens entsprechend seinem Typ zurück

1
String XmlDocument.nodeValue;

Der nodeName verschiedener Objekte gibt unterschiedliche Werte zurück:


ownerDocument

XmlDocument, gibt das Wurzelelement des Knotens (XmlDocument-Objekt) zurück

1
readonly XmlDocument XmlDocument.ownerDocument;

parentNode

XmlNode, Kann den Elternknoten eines Knotens zurückgeben

1
readonly XmlNode XmlDocument.parentNode;

childNodes

XmlNodeList, Gibt die Knotenliste der Kindknoten des angegebenen Knotens zurück

1
readonly XmlNodeList XmlDocument.childNodes;

firstChild

XmlNode, Gibt den ersten untergeordneten Knoten des Knotens zurück

1
readonly XmlNode XmlDocument.firstChild;

lastChild

XmlNode, Den letzten untergeordneten Knoten des Knotens zurückgeben

1
readonly XmlNode XmlDocument.lastChild;

previousSibling

XmlNode, Gibt den Knoten direkt vor einem bestimmten Knoten (auf derselben Baumebene) zurück, wenn kein solcher Knoten vorhanden ist, dann gibt das Attribut null zurück

1
readonly XmlNode XmlDocument.previousSibling;

nextSibling

XmlNode, Gibt den Knoten zurück, der einem Element unmittelbar folgt (in derselben Baumebene), wenn kein solcher Knoten vorhanden ist, gibt die Eigenschaft null zurück

1
readonly XmlNode XmlDocument.nextSibling;

Mitgliederfunktion

load

Verfassen Sie das Dokument durch das Parsen eines XML/HTML-Strings, unterstützt keine Mehrsprachigkeit

1
XmlDocument.load(String source);

Aufrufparameter:

  • source: String, der zu analysierende XML/HTML-Text, abhängig vom Dokumenttyp bei der Erstellung

Das Dokument wird durch das Parsen eines binären XML/HTML-Strings erstellt und automatisch entsprechend der Sprache konvertiert

1
XmlDocument.load(Buffer source);

Aufrufparameter:

  • 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

1
XmlNodeList XmlDocument.getElementsByTagName(String tagName);

Aufrufparameter:

  • tagName: String, der abzurufende Tag-Name. Der Wert "*" entspricht allen Tags

Ergebnis zurückgeben:

  • XmlNodeList, Mit der angegebenen Markierung im Dokumentenbaum XmlElement Knoten XmlNodeListeinstellen. Die Reihenfolge der zurückgegebenen Elementknoten entspricht der Reihenfolge, in der sie im Quelldokument erscheinen.

Diese Methode gibt a . zurück XmlNodeList Objekt (kann als schreibgeschütztes Array verarbeitet werden), das Objekt speichert alle Dokumente mit dem angegebenen Tag-Namen XmlElement Knoten, die Reihenfolge, in der sie gespeichert werden, ist die Reihenfolge, in der sie im Quelldokument erscheinen. XmlNodeList Das Objekt ist "live", dh wenn ein Element mit dem angegebenen Tag-Namen im Dokument hinzugefügt oder gelöscht wird, wird dessen Inhalt bei Bedarf automatisch aktualisiert.


getElementsByTagNameNS

Gibt eine Liste von Knoten mit allen Elementen des angegebenen Namensraums und Namens zurück

1 2
XmlNodeList XmlDocument.getElementsByTagNameNS(String namespaceURI, String localName);

Aufrufparameter:

  • namespaceURI: String, gibt den abzurufenden Namespace-URI an. Der Wert "*" kann mit allen Tags übereinstimmen
  • localName: String, der abzurufende Tag-Name. Der Wert "*" entspricht allen Tags

Ergebnis zurückgeben:

  • XmlNodeList, Mit der angegebenen Markierung im Dokumentenbaum XmlElement Knoten XmlNodeListeinstellen. Die Reihenfolge der zurückgegebenen Elementknoten entspricht der Reihenfolge, in der sie im Quelldokument erscheinen.

Diese Methode ähnelt der Methode getElementsByTagName(), außer dass sie Elemente basierend auf Namespace und Name abruft.


getElementById

Gibt das Element mit dem angegebenen id-Attribut zurück

1
XmlElement XmlDocument.getElementById(String id);

Aufrufparameter:

  • id: String, abzurufende ID

Ergebnis zurückgeben:

Diese Methode durchläuft die untergeordneten Knoten des Dokuments und gibt a . zurück XmlElementDas Node-Objekt repräsentiert das erste Dokumentelement mit dem angegebenen id-Attribut. .


getElementsByClassName

Gibt eine Knotenliste aller Elemente mit dem angegebenen Klassennamen zurück

1
XmlNodeList XmlDocument.getElementsByClassName(String className);

Aufrufparameter:

  • className: String, der Name der abzurufenden Klasse

Ergebnis zurückgeben:

  • XmlNodeList, Mit dem angegebenen Klassennamen im Dokumentenbaum XmlElement Knoten XmlNodeListeinstellen. Die Reihenfolge der zurückgegebenen Elementknoten entspricht der Reihenfolge, in der sie im Quelldokument erscheinen.

Diese Methode gibt a . zurück XmlNodeList Objekt (kann als schreibgeschütztes Array verarbeitet werden), das alle Dateien mit dem angegebenen Klassennamen im Dokument speichert XmlElement Knoten, die Reihenfolge, in der sie gespeichert werden, ist die Reihenfolge, in der sie im Quelldokument erscheinen. XmlNodeList Das Objekt ist "live", dh wenn ein Element mit dem angegebenen Tag-Namen im Dokument hinzugefügt oder gelöscht wird, wird dessen Inhalt bei Bedarf automatisch aktualisiert.


createElement

Elementknoten erstellen

1
XmlElement XmlDocument.createElement(String tagName);

Aufrufparameter:

  • tagName: String, geben Sie den angegebenen Namen des Elementknotens an

Ergebnis zurückgeben:


createElementNS

Elementknoten mit angegebenem Namensraum erstellen

1 2
XmlElement XmlDocument.createElementNS(String namespaceURI, String qualifiedName);

Aufrufparameter:

  • namespaceURI: String, geben Sie den URI des Elementknotennamensraums an
  • qualifiedName: String, geben Sie den angegebenen Namen des Elementknotens an

Ergebnis zurückgeben:


createTextNode

Textknoten erstellen

1
XmlText XmlDocument.createTextNode(String data);

Aufrufparameter:

  • data: String, geben Sie den Text dieses Knotens an

Ergebnis zurückgeben:

  • XmlText, Geben Sie das neu erstellte zurück XmlText Knoten, der den angegebenen Datenstring repräsentiert

createComment

Kommentarknoten erstellen

1
XmlComment XmlDocument.createComment(String data);

Aufrufparameter:

  • data: String, geben Sie den Kommentartext dieses Knotens an

Ergebnis zurückgeben:

  • XmlComment, Geben Sie das neu erstellte zurück XmlComment Knoten, der Kommentartext sind die angegebenen Daten

createCDATASection

erstellen XmlCDATASection Knoten

1
XmlCDATASection XmlDocument.createCDATASection(String data);

Aufrufparameter:

  • data: String, geben Sie diesen Knoten an, um CDATA-Daten anzugeben

Ergebnis zurückgeben:


createProcessingInstruction

erstellen XmlProcessingInstruction Knoten

1 2
XmlProcessingInstruction XmlDocument.createProcessingInstruction(String target, String data);

Aufrufparameter:

  • target: String, spezifizieren Sie das Ziel der Verarbeitungsanweisung
  • data: String, Inhaltstext der Verarbeitungsanweisung angeben

Ergebnis zurückgeben:


hasChildNodes

Abfrage, ob untergeordnete Knoten vorhanden sind

1
Boolean XmlDocument.hasChildNodes();

Ergebnis zurückgeben:

  • Boolean, Gib true zurück, wenn untergeordnete Knoten vorhanden sind, andernfalls gebe false zurück

normalize

Zusammenfügen benachbarter Textknoten und Löschen leerer Textknoten delete

1
XmlDocument.normalize();

Diese Methode durchläuft alle Nachkommen des aktuellen Knotens und normalisiert das Dokument, indem der leere Text-Knoten gelöscht und alle angrenzenden Text-Knoten 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 exakte Kopie des angegebenen Knotens

1
XmlNode XmlDocument.cloneNode(Boolean deep = true);

Aufrufparameter:

  • deep: Boolean, ob Deep Copy, wenn wahr, der geklonte Knoten klont alle untergeordneten Knoten des ursprünglichen Knotens

Ergebnis zurückgeben:

  • XmlNode, Den kopierten Knoten zurückgeben

Diese Methode kopiert und gibt eine Kopie des Knotens zurück, der sie aufgerufen hat. 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 parentNode-Eigenschaft 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

1
String XmlDocument.lookupPrefix(String namespaceURI);

Aufrufparameter:

  • namespaceURI: String, geben Sie den passenden Namespace-URI an

Ergebnis zurückgeben:

  • String, Gibt das übereinstimmende Präfix zurück, 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

1
String XmlDocument.lookupNamespaceURI(String prefix);

Aufrufparameter:

  • prefix: String, geben Sie das passende Präfix an

Ergebnis zurückgeben:

  • String, Gibt den passenden Namespace-URI zurück, gibt null zurück, wenn er nicht übereinstimmt

insertBefore

Fügen Sie einen neuen untergeordneten Knoten vor dem vorhandenen untergeordneten Knoten ein

1 2
XmlNode XmlDocument.insertBefore(XmlNode newChild, XmlNode refChild);

Aufrufparameter:

  • newChild: XmlNode, Füge einen neuen Knoten ein
  • refChild: XmlNode, Füge einen neuen Knoten vor diesem Knoten ein

Ergebnis zurückgeben:

  • XmlNode, Gibt den neuen untergeordneten Knoten zurück

Existiert newChild bereits im Dokumentenbaum, wird es aus dem Dokumentenbaum 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 einen neuen untergeordneten Knoten nach dem vorhandenen untergeordneten Knoten ein

1 2
XmlNode XmlDocument.insertAfter(XmlNode newChild, XmlNode refChild);

Aufrufparameter:

  • newChild: XmlNode, Füge einen neuen Knoten ein
  • refChild: XmlNode, Fügen Sie nach diesem Knoten einen neuen Knoten ein

Ergebnis zurückgeben:

  • XmlNode, Gibt den neuen untergeordneten Knoten zurück

Existiert newChild bereits im Dokumentenbaum, wird es aus dem Dokumentenbaum 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

1
XmlNode XmlDocument.appendChild(XmlNode newChild);

Aufrufparameter:

  • newChild: XmlNode, Geben Sie den hinzugefügten Knoten an

Ergebnis zurückgeben:

  • XmlNode, Diesen neuen untergeordneten Knoten zurückgeben

Existiert newChild bereits im Dokumentenbaum, wird es aus dem Dokumentenbaum 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 2
XmlNode XmlDocument.replaceChild(XmlNode newChild, XmlNode oldChild);

Aufrufparameter:

  • 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, gibt sie null zurück

Existiert newChild bereits im Dokumentenbaum, wird es aus dem Dokumentenbaum 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

Einen Knoten aus der Liste der untergeordneten Knoten entfernen

1
XmlNode XmlDocument.removeChild(XmlNode oldChild);

Aufrufparameter:

  • 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 sie fehlschlägt, gibt sie null zurück

toString

Gibt die String-Darstellung des Objekts zurück, gibt im Allgemeinen "[Native Object]" zurück, das Objekt kann entsprechend seiner eigenen Eigenschaften neu implementiert werden

1
String 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, gibt im Allgemeinen eine Sammlung von lesbaren Attributen zurück, die durch das Objekt definiert sind

1
Value XmlDocument.toJSON(String key = "");

Aufrufparameter:

  • key: String, unbenutzt

Ergebnis zurückgeben:

  • Value, Gibt einen Wert zurück, der JSON serialisierbar enthält