Cette page a été traduite par l'API Cloud Translation.

Class Element

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.
let xml = '<things>' +
    '<plates>12</plates>' +
    '<bowls>18</bowls>' +
    '<cups>25</cups>' +
    '</things>';
const document = XmlService.parse(xml);
const root = document.getRootElement();
const items = root.getChildren();
let total = 0;
for (let i = 0; i < items.length; i++) {
  total += Number(items[i].getText());
}
const 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é à 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`	Détache le nœud de son nœud `Element` parent.
`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`	Obtient 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` portant 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 à 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 `Element` parent 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`	Indique 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`, si un tel attribut existe.
`removeAttribute(attributeName)`	`Boolean`	Supprime l'attribut de ce nœud `Element` avec le nom donné et sans espace de noms, s'il existe.
`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 à 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 donnés, 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 donné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 un objet de nœud correspondant à un type listé dans ContentType.

Paramètres

Nom	Type	Description
`content`	`Content`	le nœud à ajouter

Renvois

Element : nœud Element, pour le chaînage

`addContent(index, content)`

Insère le nœud donné à 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 un objet de nœud correspondant à un type listé dans ContentType.

Paramètres

Nom	Type	Description
`index`	`Integer`	indice à insérer pour le nœud parmi tous les nœuds qui sont des enfants immédiats du nœud `Element`
`content`	`Content`	le 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()`

Détache le nœud de son nœud Element parent. Si le nœud n'a pas de parent, cette méthode n'a aucun effet.

Renvois

Content : nœud dissocié

`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. Si aucun attribut de ce type n'existe, cette méthode renvoie null.

Paramètres

Nom	Type	Description
`name`	`String`	nom de l'attribut

Renvois

Attribute : attribut, ou null s'il n'existe pas d'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. Si aucun nœud de ce type n'existe, cette méthode renvoie null.

Paramètres

Nom	Type	Description
`name`	`String`	nom de l'attribut
`namespace`	`Namespace`	espace de noms de l'attribut

Renvois

Attribute : attribut, ou null s'il n'existe pas d'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)`

Obtient 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. Si aucun nœud de ce type n'existe, cette méthode renvoie null.

Paramètres

Nom	Type	Description
`name`	`String`	nom du nœud `Element` enfant

Renvois

Element : nœud Element, ou null s'il n'existe pas de nœud Element enfant immédiat avec le nom donné et sans 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. Si aucun nœud de ce type n'existe, cette méthode renvoie null.

Paramètres

Nom	Type	Description
`name`	`String`	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 pas de 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. Si aucun nœud de ce type n'existe, cette méthode renvoie null.

Paramètres

Nom	Type	Description
`name`	`String`	nom du nœud enfant

Renvois

String : valeur textuelle du nœud enfant, ou null s'il n'existe pas de nœud enfant immédiat avec le nom donné et sans 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. Si aucun nœud de ce type n'existe, cette méthode renvoie null.

Paramètres

Nom	Type	Description
`name`	`String`	nom du nœud enfant
`namespace`	`Namespace`	Espace de noms du nœud enfant

Renvois

String : valeur textuelle du nœud enfant, ou null s'il n'existe pas de 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 portant 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`	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`	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 portant le nom et le namespace donnés qui sont des enfants immédiats de ce nœud Element

`getContent(index)`

Récupère le nœud à 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 associé à 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 pas de 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 possède 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()`

Récupère l'espace de noms du nœud Element.

Renvois

Namespace : espace de noms du nœud Element

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

Récupère le nœud Element parent du nœud. Si le nœud n'a pas de parent, cette méthode renvoie null.

Renvois

Element : nœud Element parent

`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)`

Indique 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 sinon

`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 sinon

`removeAttribute(attribute)`

Supprime l'attribut donné pour ce nœud Element, si un tel attribut existe.

Paramètres

Nom	Type	Description
`attribute`	`Attribute`	l'attribut

Renvois

Boolean : true si l'attribut existait et a été supprimé, false sinon

`removeAttribute(attributeName)`

Supprime l'attribut de ce nœud Element avec le nom donné et sans espace de noms, s'il existe.

Paramètres

Nom	Type	Description
`attributeName`	`String`	nom de l'attribut

Renvois

Boolean : true si l'attribut existait et a été supprimé, false sinon

`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`	nom de l'attribut
`namespace`	`Namespace`	espace de noms de l'attribut

Renvois

Boolean : true si l'attribut existait et a été supprimé, false sinon

`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 d'être supprimés

`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 n'importe quel objet de nœud correspondant à un type listé 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 sinon

`removeContent(index)`

Supprime le nœud à 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 associé à 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 pas de nœud à l'index donné

`setAttribute(attribute)`

Définit l'attribut donné pour ce nœud Element.

Paramètres

Nom	Type	Description
`attribute`	`Attribute`	l'attribut à définir

Renvois

Element : nœud Element, pour le chaînage

`setAttribute(name, value)`

Définit l'attribut de ce nœud Element avec le nom et la valeur donnés, sans espace de noms.

Paramètres

Nom	Type	Description
`name`	`String`	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 donnés.

Paramètres

Nom	Type	Description
`name`	`String`	Nom de l'attribut à définir
`value`	`String`	la valeur de l'attribut à définir ;
`namespace`	`Namespace`	Namespace 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`	Nom local à définir

Renvois

Element : nœud Element, pour le chaînage

`setNamespace(namespace)`

Définit l'espace de noms du nœud Element.

Paramètres

Nom	Type	Description
`namespace`	`Namespace`	l'espace de noms à définir

Renvois

Element : nœud Element, pour le chaînage

`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