Objet XmlDocument

L'objet XmlDocument représente l'ensemble du document XML

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

Héritage

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 avez besoin de traiter html, vous devez spécifier "text / html"

Attributs des membres

inputEncoding

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

1
readonly String XmlDocument.inputEncoding;

xmlStandalone

Boolean, définir ou renvoyer si le document est autonome

1
Boolean XmlDocument.xmlStandalone;

xmlVersion

Chaîne, définir ou renvoyer la version XML du document

1
String XmlDocument.xmlVersion;

doctype

XmlDocumentType , retourne la déclaration de type de document liée au document (Document Type Declaration)

1
readonly XmlDocumentType XmlDocument.doctype;

Pour les documents XML sans DTD, null est renvoyé. Cette propriété fournit un accès direct à l'objet XmlDocumentType (un nœud enfant de XmlDocument).

documentElement

XmlElement , retourne le nœud racine du document

1
readonly XmlElement XmlDocument.documentElement;

head

XmlElement , retourne le nœud principal du document HTML, uniquement valide en mode html

1
readonly XmlElement XmlDocument.head;

title

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

1
readonly String XmlDocument.title;

body

XmlElement , retourne le nœud du corps du document HTML, uniquement valide 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 des valeurs différentes:

• 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, renvoie le nom du nœud, selon son type

1
readonly String XmlDocument.nodeName;

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

• XmlElement : nom de l'élément
• XmlAttr : nom d'attribut
• XmlText : #text
• XmlCDATASection : # cdata-section
• XmlProcessingInstruction : renvoie la cible cible spécifiée
• XmlComment : XmlComment
• XmlDocument : #document
• XmlDocumentType : nom doctype

nodeValue

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

1
String XmlDocument.nodeValue;

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

• XmlElement : null
• XmlAttr : la valeur de l'attribut
• XmlText : le contenu du nœud
• XmlCDATASection : le contenu du nœud
• XmlProcessingInstruction : XmlProcessingInstruction les données de contenu spécifiées
• XmlComment : texte du commentaire
• XmlDocument : null
• XmlDocumentType : null

ownerDocument

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

1
readonly XmlDocument XmlDocument.ownerDocument;

parentNode

XmlNode , peut retourner le nœud parent d'un nœud

1
readonly XmlNode XmlDocument.parentNode;

childNodes

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

1
readonly XmlNodeList XmlDocument.childNodes;

firstChild

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

1
readonly XmlNode XmlDocument.firstChild;

lastChild

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

1
readonly XmlNode XmlDocument.lastChild;

previousSibling

XmlNode , renvoie le nœud immédiatement avant un nœud (au même niveau de l'arborescence), s'il n'y en a pas, cet attribut retourne null

1
readonly XmlNode XmlDocument.previousSibling;

nextSibling

XmlNode , renvoie le nœud immédiatement après un élément (dans le même niveau d'arborescence), s'il n'y a pas de tel nœud, l'attribut 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 plusieurs langues

1
XmlDocument.load(String source);

Paramètres d'appel:

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

Composez le document en analysant une chaîne XML / HTML binaire et convertissez-le automatiquement 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 avec 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 , une collection de XmlNodeList de nœuds XmlElement avec des balises spécifiées dans l'arborescence du document. L'ordre des nœuds d'élément renvoyés est l'ordre dans lequel ils apparaissent dans le document source.

Cette méthode retourne un objet XmlNodeList (qui peut être traité comme un tableau en lecture seule), qui stocke tous les nœuds XmlElement dans le document avec le nom de balise spécifié, et l'ordre dans lequel ils sont stockés est l'ordre dans lequel ils apparaissent dans le document source. XmlNodeList objet XmlNodeList est "live", c'est-à-dire que si un élément avec un 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 de tous les éléments avec l'espace de noms et le nom spécifiés

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

Paramètres d'appel:

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

Résultat de retour:

• XmlNodeList , une collection de XmlNodeList de nœuds XmlElement avec des balises spécifiées dans l'arborescence du document. L'ordre des nœuds d'élément 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, id à récupérer

Résultat de retour:

• XmlElement , le nœud XmlElement avec l'attribut id spécifié dans l'arborescence des nœuds

Cette méthode traversera les nœuds descendants du document et retournera un objet nœud XmlElement représentant 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 , la XmlNodeList collection de XmlElement noeuds avec le nom de classe spécifié dans l'arborescence du document. L'ordre des nœuds d'élément renvoyés est l'ordre dans lequel ils apparaissent dans le document source.

Cette méthode renvoie un objet XmlNodeList (qui peut être traité comme un tableau en lecture seule), qui stocke tous les nœuds XmlElement avec le nom de classe spécifié dans le document. L'ordre dans lequel ils sont stockés est l'ordre dans lequel ils apparaissent dans le document source. XmlNodeList objet XmlNodeList est "live", c'est-à-dire que si un élément avec un 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 : String, spécifie le nom spécifié du nœud d'élément

Résultat de retour:

• XmlElement , renvoie le nœud XmlElement nouvellement créé avec le nom de balise spécifié

createElementNS

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

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

Paramètres d'appel:

• namespaceURI : String, spécifie l'URI de l'espace de noms du nœud d'élément
• qualifiedName : String, le nom spécifié du nœud d'élément spécifié

Résultat de retour:

• XmlElement , renvoie le nœud XmlElement nouvellement créé avec le nom de balise spécifié

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 , renvoie le nœud XmlText nouvellement créé, qui représente 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 , renvoie le nœud XmlComment nouvellement créé, le texte du commentaire est les données spécifiées

createCDATASection

Créer XmlCDATASection nœud XmlCDATASection

1
XmlCDATASection XmlDocument.createCDATASection(String data);

Paramètres d'appel:

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

Résultat de retour:

• XmlCDATASection , renvoie le nœud XmlCDATASection nouvellement créé, le contenu est les données spécifiées

createProcessingInstruction

Créer XmlProcessingInstruction nœud XmlProcessingInstruction

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 : String, spécifiez le texte du contenu de l'instruction de traitement

Résultat de retour:

• XmlProcessingInstruction , le nœud ProcessingInstruction nouvellement créé

hasChildNodes

Demander s'il existe des nœuds enfants

1
Boolean XmlDocument.hasChildNodes();

Résultat de retour:

• Boolean , retourne true s'il y a des nœuds enfants, sinon retourne 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 Texte vide et en fusionnant tous les nœuds Texte 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 : Boolean, s'il faut copier en profondeur, lorsque true, le nœud cloné clonera tous les nœuds enfants du nœud d'origine

Résultat de retour:

• XmlNode , retourne le nœud copié

Cette méthode copiera et retournera une copie du nœud qui l'a appelée. Si le paramètre qui lui est passé est true, il copiera également récursivement tous les descendants du nœud actuel. Sinon, il ne copie que le nœud actuel. Le nœud renvoyé n'appartient pas à l'arborescence du document et sa propriété parentNode est null. Lorsque le nœud Elément 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 : String, spécifiez l'URI d'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 : String, 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érez un nouveau nœud
• refChild : XmlNode , insérez un nouveau nœud avant ce nœud

Résultat de retour:

• XmlNode , retourne 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érez un nouveau nœud
• refChild : XmlNode , insérez un nouveau nœud après ce nœud

Résultat de retour:

• XmlNode , retourne 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 , retourne 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 retourner le nœud remplacé, si le remplacement échoue, elle retourne 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 est réussie, cette méthode peut retourner le nœud supprimé, si elle échoue, elle retourne null

toString

Renvoie la représentation sous forme de chaîne de l'objet, renvoie généralement "[Native Object]", 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, non utilisée

Résultat de retour:

• Value , renvoie une valeur contenant JSON sérialisable