ObjetXmlComment

Les objets XmlComment représentent le contenu des nœuds de commentaires dans le document

Le nœud XmlComment représente un commentaire dans un document XML. Utilisé parXmlCharacterDataL'attribut data hérité de l'interface, ou en utilisant leXmlNodeL'attribut nodeValue hérité par l'interface peut accéder au contenu de l'annotation. (c'est-à-dire le texte entre ). Utilisé parXmlCharacterDataDifférentes méthodes héritées de l'interface peuvent intervenir sur le contenu de l'annotation.

utiliserXmlDocument.createComment() pour créer un objet d'annotation.

relation d'héritage

propriétés des membres

data

String, le texte contenu dans ce nœud

1
String XmlComment.data;

---

length

Entier, le nombre de caractères contenus dans ce nœud

1
readonly Integer XmlComment.length;

---

nodeType

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

1
readonly Integer XmlComment.nodeType;

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

• XmlElement: ELEMENT_NODE(1)
• XmlAttr:ATTRIBUTE_NODE(2)
• XmlText: TEXTE_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 XmlComment.nodeName;

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

• XmlElement:nom de l'élément
• XmlAttr: Nom d'attribut
• XmlText: #texte
• XmlCDATASection: #cdata-section
• XmlProcessingInstruction: Renvoie la cible cible spécifiée
• XmlComment: #commentaire
• XmlDocument: #document
• XmlDocumentType: nom du type de document

---

nodeValue

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

1
String XmlComment.nodeValue;

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

• XmlElement: nul
• XmlAttr: valeur d'attribut
• XmlText: le contenu du nœud
• XmlCDATASection: le contenu du nœud
• XmlProcessingInstruction: Renvoie les données de contenu spécifiées
• XmlComment: texte d'annotation
• XmlDocument: nul
• XmlDocumentType: nul

---

ownerDocument

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

1
readonly XmlDocument XmlComment.ownerDocument;

---

parentNode

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

1
readonly XmlNode XmlComment.parentNode;

---

childNodes

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

1
readonly XmlNodeList XmlComment.childNodes;

---

children

XmlNodeList, renvoie la liste des nœuds des éléments enfants du nœud spécifié.

1
readonly XmlNodeList XmlComment.children;

---

firstChild

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

1
readonly XmlNode XmlComment.firstChild;

---

lastChild

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

1
readonly XmlNode XmlComment.lastChild;

---

previousSibling

XmlNode, renvoie le nœud précédant immédiatement un nœud (au même niveau d'arborescence). S'il n'existe pas de tel nœud, cette propriété renvoie null.

1
readonly XmlNode XmlComment.previousSibling;

---

nextSibling

XmlNode, renvoie le nœud qui suit immédiatement un élément (dans le même niveau d'arborescence). S'il n'existe pas de tel nœud, l'attribut renvoie null.

1
readonly XmlNode XmlComment.nextSibling;

---

firstElementChild

XmlNode, renvoie le premier nœud d'élément enfant du nœud

1
readonly XmlNode XmlComment.firstElementChild;

---

lastElementChild

XmlNode, renvoie le dernier nœud d'élément enfant du nœud

1
readonly XmlNode XmlComment.lastElementChild;

---

previousElementSibling

XmlNode, renvoie le nœud d'élément précédant immédiatement un nœud (au même niveau d'arborescence). S'il n'existe pas de nœud de ce type, cette propriété renvoie null.

1
readonly XmlNode XmlComment.previousElementSibling;

---

nextElementSibling

XmlNode, renvoie le nœud d'élément qui suit immédiatement un élément (dans le même niveau d'arborescence). S'il n'existe pas de tel nœud, l'attribut renvoie null.

1
readonly XmlNode XmlComment.nextElementSibling;

---

textContent

String, interroge et définit le texte de l'élément sélectionné. Lors de l'interrogation, renvoie les valeurs de tous les nœuds de texte dans le nœud d'élément ; lors de la configuration, supprime tous les nœuds enfants et les remplace par un seul nœud de texte.

1
String XmlComment.textContent;

fonction membre

substringData

Extraire la sous-chaîne du nœud

1
2
String XmlComment.substringData(Integer offset,
    Integer count);

Paramètres d'appel :

• offset: Entier, la position du premier caractère à renvoyer
• count: Entier, le nombre de caractères de la sous-chaîne à renvoyer

Résultats de retour :

• String, renvoie la chaîne extraite

---

appendData

Ajouter une chaîne au nœud

1
XmlComment.appendData(String arg);

Paramètres d'appel :

• arg: String, la chaîne à ajouter au nœud

---

insertData

Insérer une chaîne dans le nœud

1
2
XmlComment.insertData(Integer offset,
    String arg);

Paramètres d'appel :

• offset: Entier, la position du caractère à laquelle la chaîne doit être insérée dans le nœud
• arg: String, la chaîne à insérer

---

deleteData

Supprimer le texte du nœud

1
2
XmlComment.deleteData(Integer offset,
    Integer count);

Paramètres d'appel :

• offset: Entier, la position du premier caractère à supprimer
• count: Entier, le nombre de caractères à supprimer

---

replaceData

Remplacez les caractères du nœud par la chaîne spécifiée

1
2
3
XmlComment.replaceData(Integer offset,
    Integer count,
    String arg);

Paramètres d'appel :

• offset: Entier, la position du caractère du nœud à remplacer
• count: Entier, le nombre de caractères à remplacer
• arg: String, la chaîne à insérer

---

hasChildNodes

Demander s'il existe des nœuds enfants

1
Boolean XmlComment.hasChildNodes();

Résultats de retour :

• Boolean, renvoie vrai s'il y a des nœuds enfants, sinon renvoie faux

---

normalize

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

1
XmlComment.normalize();

Cette méthode traversera tous les nœuds descendants du nœud actuel et normalisera le document en supprimant les nœuds Texte vides 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ée une copie exacte du nœud spécifié

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

Paramètres d'appel :

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

Résultats de retour :

• XmlNode, renvoie le nœud copié

Cette méthode copiera et renverra une copie du nœud sur lequel elle a été appelée. Si l'argument qui lui est transmis est vrai, il copiera également de manière récursive tous les nœuds descendants du nœud actuel. Sinon, il copie uniquement le nœud actuel. Le nœud renvoyé n'appartient pas à l'arborescence du document et sa propriété parentNode est nulle. Lorsqu'un nœud Element est copié, toutes ses propriétés seront copiées.

---

lookupPrefix

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

1
String XmlComment.lookupPrefix(String namespaceURI);

Paramètres d'appel :

• namespaceURI: String, spécifie l'URI de l'espace de noms correspondant

Résultats de retour :

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

---

lookupNamespaceURI

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

1
String XmlComment.lookupNamespaceURI(String prefix);

Paramètres d'appel :

• prefix: String, spécifie le préfixe correspondant

Résultats 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 un nœud enfant existant

1
2
XmlNode XmlComment.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ésultats de retour :

• XmlNode, renvoie le nouveau nœud enfant

Si newChild existe déjà dans l’arborescence des documents, il sera supprimé de l’arborescence des documents et réinséré à 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. Autrement dit, l'attribut OwnerDocument de newChild doit être le même que l'attribut OwnerDocument du nœud actuel.

---

insertAfter

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

1
2
XmlNode XmlComment.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ésultats de retour :

• XmlNode, renvoie le nouveau nœud enfant

Si newChild existe déjà dans l’arborescence des documents, il sera supprimé de l’arborescence des documents et réinséré à 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. Autrement dit, l'attribut OwnerDocument de newChild doit être le même que l'attribut OwnerDocument du nœud actuel.

---

appendChild

Ajoute un nouveau nœud enfant à la fin de la liste des nœuds enfants d'un nœud

1
XmlNode XmlComment.appendChild(XmlNode newChild);

Paramètres d'appel :

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

Résultats de retour :

• XmlNode, renvoie ce nouveau nœud enfant

Si newChild existe déjà dans l’arborescence des documents, il sera supprimé de l’arborescence des documents et réinséré à 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. Autrement dit, l'attribut OwnerDocument de newChild doit être le même que l'attribut OwnerDocument du nœud actuel.

---

replaceChild

Remplacer un nœud enfant par un autre

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

Paramètres d'appel :

• newChild:XmlNode, spécifiez le nouveau nœud
• oldChild:XmlNode, spécifie le nœud à remplacer

Résultats 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 des documents, il sera supprimé de l’arborescence des documents et réinséré à 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. Autrement dit, l'attribut OwnerDocument de newChild doit être le même que l'attribut OwnerDocument du nœud actuel.

---

removeChild

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

1
XmlNode XmlComment.removeChild(XmlNode oldChild);

Paramètres d'appel :

• oldChild:XmlNode, spécifie le nœud à supprimer

Résultats de retour :

• XmlNode, Si la suppression réussit, cette méthode peut renvoyer le nœud supprimé. En cas d'échec, elle renvoie null.

---

toString

Renvoie la représentation sous forme de chaîne de l'objet. Généralement, "[Native Object]" est renvoyé. L'objet peut être réimplémenté en fonction de ses propres caractéristiques.

1
String XmlComment.toString();

Résultats de retour :

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

---

toJSON

Renvoie une représentation au format JSON de l'objet, renvoyant généralement une collection de propriétés lisibles définies par l'objet.

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

Paramètres d'appel :

• key: Chaîne, non utilisée

Résultats de retour :

• Value, renvoie une valeur contenant du JSON sérialisable