Class Element

Élément

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éthodeType renvoyéBrève description
addContent(content)ElementAjoute le nœud donné en tant que dernier enfant du nœud Element.
addContent(index, content)ElementInsè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()ContentDé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)AttributeRécupère l'attribut de ce nœud Element avec le nom donné et sans espace de noms.
getAttribute(name, namespace)AttributeRé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)ElementObtient 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)ElementRé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)StringRé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)StringRé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)ContentRé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()IntegerRé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()DocumentRécupère le document XML contenant le nœud {@code Element}.
getName()StringRécupère le nom local du nœud Element.
getNamespace()NamespaceRécupère l'espace de noms du nœud Element.
getNamespace(prefix)NamespaceRécupère l'espace de noms avec le préfixe donné pour le nœud Element.
getParentElement()ElementRécupère le nœud Element parent du nœud.
getQualifiedName()StringRécupère le nom local et le préfixe d'espace de noms du nœud Element, au format [namespacePrefix]:[localName].
getText()StringRécupère la valeur textuelle du nœud Element.
getValue()StringRé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)BooleanIndique si ce nœud Element est un parent direct ou indirect d'un nœud Element donné.
isRootElement()BooleanDétermine si le nœud Element est le nœud racine du document.
removeAttribute(attribute)BooleanSupprime l'attribut donné pour ce nœud Element, si un tel attribut existe.
removeAttribute(attributeName)BooleanSupprime l'attribut de ce nœud Element avec le nom donné et sans espace de noms, s'il existe.
removeAttribute(attributeName, namespace)BooleanSupprime 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)BooleanSupprime le nœud donné s'il est un enfant immédiat du nœud {@code Element}.
removeContent(index)ContentSupprime le nœud à l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
setAttribute(attribute)ElementDéfinit l'attribut donné pour ce nœud Element.
setAttribute(name, value)ElementDéfinit l'attribut de ce nœud Element avec le nom et la valeur donnés, sans espace de noms.
setAttribute(name, value, namespace)ElementDéfinit l'attribut de ce nœud Element avec le nom, la valeur et l'espace de noms donnés.
setName(name)ElementDéfinit le nom local du nœud Element.
setNamespace(namespace)ElementDéfinit l'espace de noms du nœud Element.
setText(text)ElementDé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

NomTypeDescription
contentContentle 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

NomTypeDescription
indexIntegerindice à insérer pour le nœud parmi tous les nœuds qui sont des enfants immédiats du nœud Element
contentContentle 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

NomTypeDescription
nameStringnom 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

NomTypeDescription
nameStringnom de l'attribut
namespaceNamespaceespace 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

NomTypeDescription
nameStringnom 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

NomTypeDescription
nameStringnom du nœud Element enfant
namespaceNamespaceEspace 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

NomTypeDescription
nameStringnom 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

NomTypeDescription
nameStringnom du nœud enfant
namespaceNamespaceEspace 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

NomTypeDescription
nameStringnom 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

NomTypeDescription
nameStringnom des nœuds Element enfants
namespaceNamespaceEspace 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

NomTypeDescription
indexIntegerl'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

NomTypeDescription
prefixStringle 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

NomTypeDescription
otherElementl'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

NomTypeDescription
attributeAttributel'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

NomTypeDescription
attributeNameStringnom 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

NomTypeDescription
attributeNameStringnom de l'attribut
namespaceNamespaceespace 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

NomTypeDescription
contentContentle 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

NomTypeDescription
indexIntegerl'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

NomTypeDescription
attributeAttributel'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

NomTypeDescription
nameStringNom de l'attribut à définir
valueStringla 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

NomTypeDescription
nameStringNom de l'attribut à définir
valueStringla valeur de l'attribut à définir ;
namespaceNamespaceNamespace 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

NomTypeDescription
nameStringNom 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

NomTypeDescription
namespaceNamespacel'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

NomTypeDescription
textStringle texte à définir

Renvois

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