Représentation d'un nœud XML Element
.
// Adds up the values listed in a sample XML document and adds a new element with the total. var xml = '<things>' + '<plates>12</plates>' + '<bowls>18</bowls>' + '<cups>25</cups>' + '</things>'; var document = XmlService.parse(xml); var root = document.getRootElement(); var items = root.getChildren(); var total = 0; for (var i = 0; i < items.length; i++) { total += Number(items[i].getText()); } var totalElement = XmlService.createElement('total').setText(total); root.addContent(totalElement); xml = XmlService.getPrettyFormat().format(document); Logger.log(xml);
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addContent(content) | Element | Ajoute le nœud donné en tant que dernier enfant du nœud Element . |
addContent(index, content) | Element | Insère le nœud donné au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud Element . |
cloneContent() | Content[] | Crée des copies non associées de tous les nœuds qui sont des enfants immédiats du nœud {@code Element}. |
detach() | Content | Dissocie le nœud de son nœud parent Element . |
getAllContent() | Content[] | Récupère tous les nœuds qui sont des enfants immédiats du nœud {@code Element}. |
getAttribute(name) | Attribute | Récupère l'attribut de ce nœud Element avec le nom donné et sans espace de noms. |
getAttribute(name, namespace) | Attribute | Récupère l'attribut de ce nœud Element avec le nom et l'espace de noms donnés. |
getAttributes() | Attribute[] | Récupère tous les attributs de ce nœud Element , dans l'ordre dans lequel ils apparaissent dans le document. |
getChild(name) | Element | Récupère le premier nœud Element avec le nom donné et sans espace de noms qui est un enfant immédiat de ce nœud Element . |
getChild(name, namespace) | Element | Récupère le premier nœud Element avec le nom et l'espace de noms donnés, qui est un enfant immédiat de ce nœud Element . |
getChildText(name) | String | Récupère la valeur textuelle du nœud avec le nom donné et sans espace de noms, si le nœud est un enfant immédiat du nœud Element . |
getChildText(name, namespace) | String | Récupère la valeur textuelle du nœud avec le nom et l'espace de noms donnés, si le nœud est un enfant immédiat du nœud Element . |
getChildren() | Element[] | Récupère tous les nœuds Element qui sont des enfants immédiats de ce nœud Element , dans l'ordre dans lequel ils apparaissent dans le document. |
getChildren(name) | Element[] | Récupère tous les nœuds Element avec le nom donné et sans espace de noms qui sont des enfants immédiats de ce nœud Element , dans l'ordre dans lequel ils apparaissent dans le document. |
getChildren(name, namespace) | Element[] | Récupère tous les nœuds Element avec le nom et l'espace de noms donnés qui sont des enfants immédiats de ce nœud Element , dans l'ordre dans lequel ils apparaissent dans le document. |
getContent(index) | Content | Récupère le nœud avec l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}. |
getContentSize() | Integer | Récupère le nombre de nœuds qui sont des enfants immédiats du nœud {@code Element}. |
getDescendants() | Content[] | Récupère tous les nœuds qui sont des enfants directs ou indirects du nœud {@code Element}, dans l'ordre dans lequel ils apparaissent dans le document. |
getDocument() | Document | Récupère le document XML contenant le nœud {@code Element}. |
getName() | String | Récupère le nom local du nœud Element . |
getNamespace() | Namespace | Récupère l'espace de noms du nœud Element . |
getNamespace(prefix) | Namespace | Récupère l'espace de noms avec le préfixe donné pour le nœud Element . |
getParentElement() | Element | Récupère le nœud parent Element du nœud. |
getQualifiedName() | String | Récupère le nom local et le préfixe d'espace de noms du nœud Element , au format [namespacePrefix]:[localName] . |
getText() | String | Récupère la valeur textuelle du nœud Element . |
getValue() | String | Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document. |
isAncestorOf(other) | Boolean | Détermine si ce nœud Element est un parent direct ou indirect d'un nœud Element donné. |
isRootElement() | Boolean | Détermine si le nœud Element est le nœud racine du document. |
removeAttribute(attribute) | Boolean | Supprime l'attribut donné pour ce nœud Element , le cas échéant. |
removeAttribute(attributeName) | Boolean | Supprime l'attribut de ce nœud Element avec le nom donné et aucun espace de noms, le cas échéant. |
removeAttribute(attributeName, namespace) | Boolean | Supprime l'attribut de ce nœud Element avec le nom et l'espace de noms donnés, le cas échéant. |
removeContent() | Content[] | Supprime tous les nœuds qui sont des enfants immédiats du nœud {@code Element}. |
removeContent(content) | Boolean | Supprime le nœud donné, s'il est un enfant immédiat du nœud {@code Element}. |
removeContent(index) | Content | Supprime le nœud au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}. |
setAttribute(attribute) | Element | Définit l'attribut donné pour ce nœud Element . |
setAttribute(name, value) | Element | Définit l'attribut de ce nœud Element avec le nom et la valeur indiqués, et sans espace de noms. |
setAttribute(name, value, namespace) | Element | Définit l'attribut de ce nœud Element avec le nom, la valeur et l'espace de noms indiqués. |
setName(name) | Element | Définit le nom local du nœud Element . |
setNamespace(namespace) | Element | Définit l'espace de noms du nœud Element . |
setText(text) | Element | Définit la valeur textuelle du nœud Element . |
Documentation détaillée
addContent(content)
Ajoute le nœud donné en tant que dernier enfant du nœud Element
. L'argument content
peut être un objet Element
ou tout objet nœud correspondant à un type répertorié dans ContentType
.
Paramètres
Nom | Type | Description |
---|---|---|
content | Content | nœud à ajouter |
Renvois
Element
: nœud Element
, pour le chaînage
addContent(index, content)
Insère le nœud donné au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud Element
. L'argument content
peut être un objet Element
ou tout objet de nœud correspondant à un type répertorié dans ContentType
.
Paramètres
Nom | Type | Description |
---|---|---|
index | Integer | Index auquel insérer le nœud parmi tous les nœuds qui sont des enfants immédiats du nœud Element |
content | Content | nœud à insérer |
Renvois
Element
: nœud Element
, pour le chaînage
cloneContent()
Crée des copies non associées de tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
Renvois
Content[]
: tableau de copies non associées de tous les nœuds qui sont des enfants immédiats du nœud {@code Element}
detach()
getAllContent()
Récupère tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
Renvois
Content[]
: tableau de tous les nœuds qui sont des enfants immédiats du nœud {@code Element}
getAttribute(name)
Récupère l'attribut de ce nœud Element
avec le nom donné et sans espace de noms. S'il n'existe pas d'attribut de ce type, cette méthode renvoie null
.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nom de l'attribut ; |
Renvois
Attribute
: attribut, ou null
s'il n'existe aucun attribut portant le nom donné et aucun espace de noms
getAttribute(name, namespace)
Récupère l'attribut de ce nœud Element
avec le nom et l'espace de noms donnés. S'il n'existe aucun nœud de ce type, cette méthode renvoie null
.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nom de l'attribut ; |
namespace | Namespace | l'espace de noms de l'attribut |
Renvois
Attribute
: attribut, ou null
s'il n'existe aucun attribut avec le nom et l'espace de noms donnés
getAttributes()
Récupère tous les attributs de ce nœud Element
, dans l'ordre dans lequel ils apparaissent dans le document.
Renvois
Attribute[]
: tableau de tous les attributs de ce nœud Element
getChild(name)
Récupère le premier nœud Element
avec le nom donné et sans espace de noms qui est un enfant immédiat de ce nœud Element
. S'il n'existe aucun nœud de ce type, cette méthode renvoie null
.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Le nom du nœud Element enfant |
Renvois
Element
: nœud Element
, ou null
s'il n'existe aucun nœud Element
enfant immédiat portant le nom donné et aucun espace de noms
getChild(name, namespace)
Récupère le premier nœud Element
avec le nom et l'espace de noms donnés, qui est un enfant immédiat de ce nœud Element
. S'il n'existe aucun nœud de ce type, cette méthode renvoie null
.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Le nom du nœud Element enfant |
namespace | Namespace | Espace de noms du nœud Element enfant |
Renvois
Element
: nœud Element
, ou null
s'il n'existe aucun nœud Element
enfant immédiat avec le nom et l'espace de noms donnés
getChildText(name)
Récupère la valeur textuelle du nœud avec le nom donné et sans espace de noms, si le nœud est un enfant immédiat du nœud Element
. S'il n'existe aucun nœud de ce type, cette méthode renvoie null
.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nom du nœud enfant ; |
Renvois
String
: valeur textuelle du nœud enfant, ou null
s'il n'existe aucun nœud enfant immédiat avec le nom donné et aucun espace de noms
getChildText(name, namespace)
Récupère la valeur textuelle du nœud avec le nom et l'espace de noms donnés, si le nœud est un enfant immédiat du nœud Element
. S'il n'existe aucun nœud de ce type, cette méthode renvoie null
.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nom du nœud enfant ; |
namespace | Namespace | l'espace de noms du nœud enfant |
Renvois
String
: valeur textuelle du nœud enfant, ou null
s'il n'existe aucun nœud enfant immédiat avec le nom et l'espace de noms donnés
getChildren()
Récupère tous les nœuds Element
qui sont des enfants immédiats de ce nœud Element
, dans l'ordre dans lequel ils apparaissent dans le document.
Renvois
Element[]
: tableau de tous les nœuds Element
qui sont des enfants immédiats de ce nœud Element
getChildren(name)
Récupère tous les nœuds Element
avec le nom donné et sans espace de noms qui sont des enfants immédiats de ce nœud Element
, dans l'ordre dans lequel ils apparaissent dans le document.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Le nom des nœuds Element enfants |
Renvois
Element[]
: tableau de tous les nœuds Element
portant le nom donné et sans espace de noms qui sont des enfants immédiats de ce nœud Element
getChildren(name, namespace)
Récupère tous les nœuds Element
avec le nom et l'espace de noms donnés qui sont des enfants immédiats de ce nœud Element
, dans l'ordre dans lequel ils apparaissent dans le document.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Le nom des nœuds Element enfants |
namespace | Namespace | Espace de noms des nœuds Element enfants |
Renvois
Element[]
: tableau de tous les nœuds Element
avec le nom et l'espace de noms donnés qui sont des enfants immédiats de ce nœud Element
getContent(index)
Récupère le nœud avec l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}. Si aucun nœud n'est disponible à l'index donné, cette méthode renvoie null
.
Paramètres
Nom | Type | Description |
---|---|---|
index | Integer | l'index du nœud parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element} |
Renvois
Content
: nœud, ou null
s'il n'y a aucun nœud à l'index donné
getContentSize()
Récupère le nombre de nœuds qui sont des enfants immédiats du nœud {@code Element}.
Renvois
Integer
: nombre de nœuds qui sont des enfants immédiats du nœud {@code Element}
getDescendants()
Récupère tous les nœuds qui sont des enfants directs ou indirects du nœud {@code Element}, dans l'ordre dans lequel ils apparaissent dans le document.
Renvois
Content[]
: tableau de tous les nœuds qui sont des enfants directs ou indirects du nœud {@code Element}
getDocument()
Récupère le document XML contenant le nœud {@code Element}.
Renvois
Document
: document contenant le nœud {@code Element}
getName()
Récupère le nom local du nœud Element
. Si le nœud comporte un préfixe d'espace de noms, utilisez getQualifiedName()
ou getNamespace()
.getPrefix()
pour obtenir le préfixe.
Renvois
String
: nom local du nœud Element
getNamespace()
getNamespace(prefix)
Récupère l'espace de noms avec le préfixe donné pour le nœud Element
.
Paramètres
Nom | Type | Description |
---|---|---|
prefix | String | le préfixe de l'espace de noms ; |
Renvois
Namespace
: espace de noms avec le préfixe donné pour le nœud Element
getParentElement()
getQualifiedName()
Récupère le nom local et le préfixe d'espace de noms du nœud Element
, au format [namespacePrefix]:[localName]
. Si le nœud ne comporte pas de préfixe d'espace de noms, utilisez getName()
.
Renvois
String
: nom local et préfixe d'espace de noms du nœud Element
, au format [namespacePrefix]:[localName]
.
getText()
Récupère la valeur textuelle du nœud Element
.
Renvois
String
: valeur textuelle du nœud Element
getValue()
Récupère la valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud, dans l'ordre dans lequel ils apparaissent dans le document.
Renvois
String
: valeur textuelle de tous les nœuds qui sont des enfants directs ou indirects du nœud
isAncestorOf(other)
Détermine si ce nœud Element
est un parent direct ou indirect d'un nœud Element
donné.
Paramètres
Nom | Type | Description |
---|---|---|
other | Element | l'autre nœud Element |
Renvois
Boolean
: true
si ce nœud Element
est un parent direct ou indirect du nœud Element
donné ; false
dans le cas contraire
isRootElement()
Détermine si le nœud Element
est le nœud racine du document.
Renvois
Boolean
: true
si le nœud Element
est le nœud racine du document ; false
dans le cas contraire.
removeAttribute(attribute)
Supprime l'attribut donné pour ce nœud Element
, le cas échéant.
Paramètres
Nom | Type | Description |
---|---|---|
attribute | Attribute | l'attribut |
Renvois
Boolean
: true
si l'attribut existait et a été supprimé ; false
dans le cas contraire
removeAttribute(attributeName)
Supprime l'attribut de ce nœud Element
avec le nom donné et aucun espace de noms, le cas échéant.
Paramètres
Nom | Type | Description |
---|---|---|
attributeName | String | le nom de l'attribut ; |
Renvois
Boolean
: true
si l'attribut existait et a été supprimé ; false
dans le cas contraire
removeAttribute(attributeName, namespace)
Supprime l'attribut de ce nœud Element
avec le nom et l'espace de noms donnés, le cas échéant.
Paramètres
Nom | Type | Description |
---|---|---|
attributeName | String | le nom de l'attribut ; |
namespace | Namespace | l'espace de noms de l'attribut |
Renvois
Boolean
: true
si l'attribut existait et a été supprimé ; false
dans le cas contraire
removeContent()
Supprime tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
Renvois
Content[]
: tableau de tous les nœuds qui étaient des enfants immédiats du nœud {@code Element} avant leur suppression
removeContent(content)
Supprime le nœud donné, s'il est un enfant immédiat du nœud {@code Element}. L'argument content
peut être un objet Element
ou tout objet de nœud correspondant à un type répertorié dans ContentType
.
Paramètres
Nom | Type | Description |
---|---|---|
content | Content | le nœud à supprimer |
Renvois
Boolean
: true
si le nœud était un enfant immédiat et a été supprimé ; false
dans le cas contraire
removeContent(index)
Supprime le nœud au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}. Si aucun nœud n'est disponible à l'index donné, cette méthode renvoie null
.
Paramètres
Nom | Type | Description |
---|---|---|
index | Integer | l'index du nœud parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element} |
Renvois
Content
: nœud supprimé ou null
s'il n'y a aucun nœud à l'index donné
setAttribute(attribute)
setAttribute(name, value)
Définit l'attribut de ce nœud Element
avec le nom et la valeur indiqués, et sans espace de noms.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nom de l'attribut à définir |
value | String | la valeur de l'attribut à définir |
Renvois
Element
: nœud Element
, pour le chaînage
setAttribute(name, value, namespace)
Définit l'attribut de ce nœud Element
avec le nom, la valeur et l'espace de noms indiqués.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nom de l'attribut à définir |
value | String | la valeur de l'attribut à définir |
namespace | Namespace | l'espace de noms de l'attribut à définir |
Renvois
Element
: nœud Element
, pour le chaînage
setName(name)
Définit le nom local du nœud Element
. Pour définir un préfixe d'espace de noms pour le nœud, utilisez setNamespace(namespace)
avec XmlService.getNamespace(prefix, uri)
.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nom local pour définir |
Renvois
Element
: nœud Element
, pour le chaînage
setNamespace(namespace)
setText(text)
Définit la valeur textuelle du nœud Element
. Si le nœud contient déjà une valeur textuelle ou des nœuds enfants, cette méthode écrase l'ancien contenu. Pour ajouter ou insérer du contenu à la place, utilisez addContent(content)
ou addContent(index, content)
.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | le texte à définir |
Renvois
Element
: nœud Element
, pour le chaînage