Objet objet intégré

Objet XmlDocument

L'objet XmlDocument représente l'intégralité du document XML

L'objet XmlDocument est la racine d'une arborescence de documents, qui nous fournit l'accès initial (ou le plus élevé) aux données du document. Pour les nœuds d'élément, les nœuds de texte, les commentaires, les instructions de traitement, etc., tous ne peuvent pas exister en dehors de XmlDocument, et l'objet XmlDocument fournit également des méthodes pour créer ces objets.XmlNode Les objets fournissent une propriété ownerDocument qui les associe au XmlDocument dans lequel ils sont créés.

Héritage

#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()

Constructeur

XmlDocument

Construire un objet XmlDocument

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

Paramètres d'appel :

  • type: String, spécifiez le type de l'objet document, la valeur par défaut est "text/xml", si vous devez traiter du html, vous devez spécifier "text/html"

Attributs des membres

inputEncoding

String, renvoie l'encodage utilisé pour le document (lors de l'analyse)

1
readonly String XmlDocument.inputEncoding;

xmlStandalone

Booléen, définit ou renvoie si le document est autonome

1
Boolean XmlDocument.xmlStandalone;

xmlVersion

Chaîne, définit ou renvoie la version XML du document

1
String XmlDocument.xmlVersion;

doctype

XmlDocumentType, Renvoie la déclaration de type de document liée au document (Déclaration de type de document)

1
readonly XmlDocumentType XmlDocument.doctype;

Pour les documents XML sans DTD, null est renvoyé. Cet attribut peut fournirXmlDocumentType Accès direct à l'objet (un nœud enfant de XmlDocument).


documentElement

XmlElement, Renvoie le nœud racine du document

1
readonly XmlElement XmlDocument.documentElement;

XmlElement, Renvoie le nœud d'en-tête du document HTML, valide uniquement en mode html

1
readonly XmlElement XmlDocument.head;

title

String, renvoie le contenu du nœud de titre du document HTML, valable uniquement en mode html

1
readonly String XmlDocument.title;

body

XmlElement, Renvoie le nœud du corps du document HTML, valide uniquement en mode html

1
readonly XmlElement XmlDocument.body;

nodeType

Entier, renvoie le type de nœud du nœud

1
readonly Integer XmlDocument.nodeType;

Le nodeType de différents objets renverra différentes valeurs :


nodeName

String, renvoie le nom du nœud, selon son type

1
readonly String XmlDocument.nodeName;

Le nodeName de différents objets renverra différentes valeurs :


nodeValue

String, renvoie le nom du nœud, selon son type

1
String XmlDocument.nodeValue;

Le nodeName de différents objets renverra différentes valeurs :


ownerDocument

XmlDocument, renvoie l'élément racine du nœud (objet XmlDocument)

1
readonly XmlDocument XmlDocument.ownerDocument;

parentNode

XmlNode, Peut renvoyer le nœud parent d'un nœud

1
readonly XmlNode XmlDocument.parentNode;

childNodes

XmlNodeList, Renvoie la liste des nœuds des nœuds enfants du nœud spécifié

1
readonly XmlNodeList XmlDocument.childNodes;

firstChild

XmlNode, Renvoie le premier nœud enfant du nœud

1
readonly XmlNode XmlDocument.firstChild;

lastChild

XmlNode, Renvoie le dernier nœud enfant du nœud

1
readonly XmlNode XmlDocument.lastChild;

previousSibling

XmlNode, Renvoie le nœud immédiatement avant un certain nœud (au même niveau d'arborescence), s'il n'y a pas de tel nœud, alors l'attribut renvoie null

1
readonly XmlNode XmlDocument.previousSibling;

nextSibling

XmlNode, Renvoie le nœud suivant immédiatement un élément (dans le même niveau d'arborescence), s'il n'y a pas de tel nœud, la propriété renvoie null

1
readonly XmlNode XmlDocument.nextSibling;

Fonction membre

load

Composez le document en analysant une chaîne XML/HTML, ne prend pas en charge le multilingue

1
XmlDocument.load(String source);

Paramètres d'appel :

  • source: String, le texte XML/HTML à analyser, selon le type de document lors de sa création

Le document est composé en analysant une chaîne XML/HTML binaire, et automatiquement converti en fonction de la langue

1
XmlDocument.load(Buffer source);

Paramètres d'appel :

  • source: Buffer, Le texte XML/HTML à analyser dépend du type de document lors de sa création

getElementsByTagName

Renvoie une liste de nœuds de tous les éléments portant le nom spécifié

1
XmlNodeList XmlDocument.getElementsByTagName(String tagName);

Paramètres d'appel :

  • tagName: String, le nom de la balise à récupérer. La valeur "*" correspond à toutes les balises

Résultat de retour :

  • XmlNodeList, Avec la marque spécifiée dans l'arborescence du document XmlElement Nodal XmlNodeListensemble. L'ordre des nœuds d'éléments renvoyés est l'ordre dans lequel ils apparaissent dans le document source.

Cette méthode renverra un XmlNodeList Objet (peut être traité comme un tableau en lecture seule), l'objet stocke tous les documents avec le nom de balise spécifié XmlElement Nœuds, l'ordre dans lequel ils sont stockés est l'ordre dans lequel ils apparaissent dans le document source. XmlNodeList L'objet est "live", c'est-à-dire que si un élément avec le nom de balise spécifié est ajouté ou supprimé dans le document, son contenu sera automatiquement mis à jour si nécessaire.


getElementsByTagNameNS

Renvoie une liste de nœuds avec tous les éléments de l'espace de noms et du nom spécifiés

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

Paramètres d'appel :

  • namespaceURI: chaîne, spécifie l'URI de l'espace de noms à récupérer. La valeur "*" peut correspondre à toutes les balises
  • localName: String, le nom de la balise à récupérer. La valeur "*" correspond à toutes les balises

Résultat de retour :

  • XmlNodeList, Avec la marque spécifiée dans l'arborescence du document XmlElement Nodal XmlNodeListensemble. L'ordre des nœuds d'éléments renvoyés est l'ordre dans lequel ils apparaissent dans le document source.

Cette méthode est similaire à la méthode getElementsByTagName(), sauf qu'elle récupère les éléments en fonction de l'espace de noms et du nom.


getElementById

Renvoie l'élément avec l'attribut id spécifié

1
XmlElement XmlDocument.getElementById(String id);

Paramètres d'appel :

  • id: chaîne, identifiant à récupérer

Résultat de retour :

Cette méthode traversera les nœuds descendants du document et retournera un XmlElementL'objet nœud représente le premier élément de document avec l'attribut id spécifié. .


getElementsByClassName

Renvoie une liste de nœuds de tous les éléments avec le nom de classe spécifié

1
XmlNodeList XmlDocument.getElementsByClassName(String className);

Paramètres d'appel :

  • className: String, le nom de la classe à récupérer

Résultat de retour :

  • XmlNodeList, Avec le nom de classe spécifié dans l'arborescence du document XmlElement Nodal XmlNodeListensemble. L'ordre des nœuds d'éléments renvoyés est l'ordre dans lequel ils apparaissent dans le document source.

Cette méthode renverra un XmlNodeList Objet (peut être traité comme un tableau en lecture seule), qui stocke tous les fichiers avec le nom de classe spécifié dans le document XmlElement Nœuds, l'ordre dans lequel ils sont stockés est l'ordre dans lequel ils apparaissent dans le document source. XmlNodeList L'objet est "live", c'est-à-dire que si un élément avec le nom de balise spécifié est ajouté ou supprimé dans le document, son contenu sera automatiquement mis à jour si nécessaire.


createElement

Créer un nœud d'élément

1
XmlElement XmlDocument.createElement(String tagName);

Paramètres d'appel :

  • tagName: chaîne, spécifiez le nom spécifié du nœud d'élément

Résultat de retour :


createElementNS

Créer un nœud d'élément avec un espace de noms spécifié

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

Paramètres d'appel :

  • namespaceURI: chaîne, spécifiez l'URI de l'espace de noms du nœud de l'élément
  • qualifiedName: chaîne, spécifiez le nom spécifié du nœud d'élément

Résultat de retour :


createTextNode

Créer un nœud de texte

1
XmlText XmlDocument.createTextNode(String data);

Paramètres d'appel :

  • data: String, spécifiez le texte de ce nœud

Résultat de retour :

  • XmlText, Renvoyez le nouveau XmlText Nœud, représentant la chaîne de données spécifiée

createComment

Créer un nœud de commentaire

1
XmlComment XmlDocument.createComment(String data);

Paramètres d'appel :

  • data: String, spécifiez le texte du commentaire de ce nœud

Résultat de retour :

  • XmlComment, Renvoyez le nouveau XmlComment Nœud, le texte du commentaire correspond aux données spécifiées

createCDATASection

créer XmlCDATASection nœud

1
XmlCDATASection XmlDocument.createCDATASection(String data);

Paramètres d'appel :

  • data: chaîne, spécifiez ce nœud pour spécifier les données CDATA

Résultat de retour :


createProcessingInstruction

créer XmlProcessingInstruction nœud

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

Paramètres d'appel :

  • target: String, spécifiez la cible de l'instruction de traitement
  • data: chaîne, spécifiez le texte du contenu de l'instruction de traitement

Résultat de retour :


hasChildNodes

Demander s'il y a des nœuds enfants

1
Boolean XmlDocument.hasChildNodes();

Résultat de retour :

  • Boolean, Renvoie true s'il y a des nœuds enfants, sinon renvoie false

normalize

Fusionner les nœuds de texte adjacents et supprimer les nœuds de texte vides

1
XmlDocument.normalize();

Cette méthode traversera tous les descendants du nœud actuel et normalisera le document en supprimant le nœud Text vide et en fusionnant tous les nœuds Text adjacents. Cette méthode est utile pour simplifier la structure de l'arborescence du document après l'insertion ou la suppression de nœuds.


cloneNode

Créer une copie exacte du nœud spécifié

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

Paramètres d'appel :

  • deep: booléen, s'il faut copier en profondeur, si vrai, le nœud cloné clonera tous les nœuds enfants du nœud d'origine

Résultat de retour :

Cette méthode copiera et renverra une copie du nœud qui l'a appelée. Si le paramètre qui lui est passé est vrai, il copiera également de manière récursive tous les descendants du nœud actuel. Sinon, il ne copie que le nœud courant. Le nœud renvoyé n'appartient pas à l'arborescence du document et sa propriété parentNode est nulle. Lorsque le nœud Element est copié, tous ses attributs seront copiés.


lookupPrefix

Renvoie le préfixe correspondant à l'URI d'espace de noms spécifié sur le nœud actuel

1
String XmlDocument.lookupPrefix(String namespaceURI);

Paramètres d'appel :

  • namespaceURI: chaîne, spécifiez l'URI de l'espace de noms correspondant

Résultat de retour :

  • String, Renvoie le préfixe correspondant, renvoie null s'il ne correspond pas

lookupNamespaceURI

Renvoie l'URI de l'espace de noms qui correspond au préfixe spécifié sur le nœud actuel

1
String XmlDocument.lookupNamespaceURI(String prefix);

Paramètres d'appel :

  • prefix: chaîne, spécifiez le préfixe correspondant

Résultat de retour :

  • String, Renvoie l'URI de l'espace de noms correspondant, renvoie null s'il ne correspond pas

insertBefore

Insérer un nouveau nœud enfant avant le nœud enfant existant

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

Paramètres d'appel :

  • newChild: XmlNode, Insérer un nouveau nœud
  • refChild: XmlNode, Insérer un nouveau nœud avant ce nœud

Résultat de retour :

  • XmlNode, Renvoie le nouveau nœud enfant

Si newChild existe déjà dans l'arborescence du document, il sera supprimé de l'arborescence du document, puis réinséré dans sa nouvelle position. Les nœuds d'un document (ou les nœuds créés par un document) ne peuvent pas être insérés dans un autre document. En d'autres termes, la propriété ownerDocument de newChild doit être la même que la propriété ownerDocument du nœud actuel.


insertAfter

Insérer un nouveau nœud enfant après le nœud enfant existant

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

Paramètres d'appel :

  • newChild: XmlNode, Insérer un nouveau nœud
  • refChild: XmlNode, Insérer un nouveau nœud après ce nœud

Résultat de retour :

  • XmlNode, Renvoie le nouveau nœud enfant

Si newChild existe déjà dans l'arborescence du document, il sera supprimé de l'arborescence du document, puis réinséré dans sa nouvelle position. Les nœuds d'un document (ou les nœuds créés par un document) ne peuvent pas être insérés dans un autre document. En d'autres termes, la propriété ownerDocument de newChild doit être la même que la propriété ownerDocument du nœud actuel.


appendChild

Ajouter un nouveau nœud enfant à la fin de la liste des nœuds enfants du nœud

1
XmlNode XmlDocument.appendChild(XmlNode newChild);

Paramètres d'appel :

  • newChild: XmlNode, Spécifiez le nœud ajouté

Résultat de retour :

  • XmlNode, Renvoie ce nouveau nœud enfant

Si newChild existe déjà dans l'arborescence du document, il sera supprimé de l'arborescence du document, puis réinséré dans sa nouvelle position. Les nœuds d'un document (ou les nœuds créés par un document) ne peuvent pas être insérés dans un autre document. En d'autres termes, la propriété ownerDocument de newChild doit être la même que la propriété ownerDocument du nœud actuel.


replaceChild

Remplacer un nœud enfant par un autre

1 2
XmlNode XmlDocument.replaceChild(XmlNode newChild, XmlNode oldChild);

Paramètres d'appel :

  • newChild: XmlNode, Spécifiez un nouveau nœud
  • oldChild: XmlNode, Spécifiez le nœud à remplacer

Résultat de retour :

  • XmlNode, Si le remplacement réussit, cette méthode peut renvoyer le nœud remplacé, si le remplacement échoue, elle renvoie null

Si newChild existe déjà dans l'arborescence du document, il sera supprimé de l'arborescence du document, puis réinséré dans sa nouvelle position. Les nœuds d'un document (ou les nœuds créés par un document) ne peuvent pas être insérés dans un autre document. En d'autres termes, la propriété ownerDocument de newChild doit être la même que la propriété ownerDocument du nœud actuel.


removeChild

Supprimer un nœud de la liste des nœuds enfants

1
XmlNode XmlDocument.removeChild(XmlNode oldChild);

Paramètres d'appel :

  • oldChild: XmlNode, Spécifiez le nœud à supprimer

Résultat de retour :

  • XmlNode, Si la suppression réussit, cette méthode peut renvoyer le nœud supprimé, si elle échoue, elle renvoie null

toString

Renvoie la représentation sous forme de chaîne de l'objet, renvoie généralement "[Objet natif]", l'objet peut être ré-implémenté selon ses propres caractéristiques

1
String XmlDocument.toString();

Résultat de retour :

  • String, Renvoie la représentation sous forme de chaîne de l'objet

toJSON

Renvoie la représentation au format JSON de l'objet, renvoie généralement une collection d'attributs lisibles définis par l'objet

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

Paramètres d'appel :

  • key: chaîne, inutilisé

Résultat de retour :

  • Value, Renvoie une valeur contenant JSON sérialisable