Class Element

Élément

Représentation d'un nœud Element XML. 

// 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 rattachées de tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.
detach()Content|nullDétache 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|nullRécupère l'attribut de ce nœud Element avec le nom donné et sans espace de noms.
getAttribute(name, namespace)Attribute|nullObtient l'attribut de ce nœud Element avec le nom et l'espace de noms spécifié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|nullObtient le premier nœud Element portant le nom donné et sans espace de noms, qui est un enfant immédiat de ce nœud Element.
getChild(name, namespace)Element|nullObtient le premier nœud Element portant le nom et l'espace de noms donnés qui est un enfant immédiat de ce nœud Element.
getChildText(name)String|nullObtient la valeur textuelle du nœud portant le nom indiqué et sans espace de noms, si le nœud est un enfant immédiat du nœud Element.
getChildText(name, namespace)String|nullObtient la valeur textuelle du nœud portant le nom et l'espace de noms spécifié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 portant 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|nullRé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()IntegerObtient 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()DocumentObtient le document XML qui contient le nœud {@code Element}.
getName()StringObtient le nom local du nœud Element.
getNamespace()NamespaceObtient l'espace de noms pour le nœud Element.
getNamespace(prefix)NamespaceObtient l'espace de noms avec le préfixe donné pour le nœud Element.
getParentElement()Element|nullObtient le nœud parent Element du nœud.
getQualifiedName()StringObtient le nom local et le préfixe de l'espace de noms du nœud Element, au format [namespacePrefix]:[localName].
getText()StringObtient 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)BooleanDétermine 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, s'il existe.
removeAttribute(attributeName)BooleanSupprime l'attribut de ce nœud Element portant le nom donné et sans espace de noms, si un tel attribut existe.
removeAttribute(attributeName, namespace)BooleanSupprime l'attribut de ce nœud Element avec le nom et l'espace de noms donnés, si un tel attribut existe.
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 s'agit d'un enfant immédiat du nœud {@code Element}.
removeContent(index)Content|nullSupprime 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 indiqué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 spécifiés.
setName(name)ElementDéfinit le nom local du nœud Element.
setNamespace(namespace)ElementDéfinit l'espace de noms pour le 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 n'importe quel objet de nœud correspondant à un type listé dans ContentType.

Paramètres

NomTypeDescription
contentContentNœud à ajouter.

Renvois

Element : le 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 n'importe quel objet de nœud correspondant à un type listé dans ContentType.

Paramètres

NomTypeDescription
indexIntegerIndex auquel insérer le nœud parmi tous les nœuds qui sont des enfants immédiats du nœud Element.
contentContentNœud à insérer.

Renvois

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

cloneContent()

Crée des copies non rattaché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 parent Element. Si le nœud n'a pas de parent, cette méthode n'a aucun effet.

Renvois

Content|null : 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|null : attribut ou null s'il n'existe aucun attribut portant le nom et l'espace de noms indiqués.

getAttribute(name, namespace)

Obtient l'attribut de ce nœud Element avec le nom et l'espace de noms spécifié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|null : attribut ou null s'il n'existe aucun attribut portant le nom et l'espace de noms indiqué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 portant 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 enfant Element.

Renvois

Element|null : nœud Element ou null s'il n'y a pas de nœud Element enfant immédiat portant le nom donné et sans espace de noms.

getChild(name, namespace)

Obtient le premier nœud Element portant 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 enfant Element.
namespaceNamespaceEspace de noms du nœud enfant Element.

Renvois

Element|null : 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)

Obtient la valeur textuelle du nœud portant le nom indiqué 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|null : valeur textuelle du nœud enfant ou null s'il n'existe pas de nœud enfant immédiat portant le nom et l'espace de noms indiqués.

getChildText(name, namespace)

Obtient la valeur textuelle du nœud portant le nom et l'espace de noms spécifié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|null : valeur textuelle du nœud enfant ou null s'il n'y a pas de nœud enfant immédiat avec le nom et l'espace de noms indiqué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 enfants Element.

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 portant 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 enfants Element.
namespaceNamespaceEspace de noms des nœuds enfants Element.

Renvois

Element[] : tableau de tous les nœuds Element portant 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 à l'index donné parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}. Si aucun nœud ne se trouve à l'index donné, cette méthode renvoie null.

Paramètres

NomTypeDescription
indexIntegerIndex du nœud parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.

Renvois

Content|null : le nœud, ou null s'il n'y a pas de nœud à l'index donné.

getContentSize()

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

Obtient le document XML qui contient le nœud {@code Element}.

Renvois

Document : document contenant le nœud {@code Element}.

getName()

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

Obtient l'espace de noms pour le nœud Element.

Renvois

Namespace : espace de noms du nœud Element.

getNamespace(prefix)

Obtient l'espace de noms avec le préfixe donné pour le nœud Element.

Paramètres

NomTypeDescription
prefixStringPréfixe de l'espace de noms.

Renvois

Namespace : espace de noms avec le préfixe donné pour le nœud Element.

getParentElement()

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

Renvois

Element|null : nœud Element parent.

getQualifiedName()

Obtient le nom local et le préfixe de l'espace de noms du nœud Element, au format [namespacePrefix]:[localName]. Si le nœud n'a 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()

Obtient 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

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 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, s'il existe.

Paramètres

NomTypeDescription
attributeAttributeAttribut.

Renvois

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

removeAttribute(attributeName)

Supprime l'attribut de ce nœud Element portant le nom donné et sans espace de noms, si un tel attribut 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, si un tel attribut existe.

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 leur suppression.

removeContent(content)

Supprime le nœud donné, s'il s'agit d'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
contentContentNœ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 ne se trouve à l'index donné, cette méthode renvoie null.

Paramètres

NomTypeDescription
indexIntegerIndex du nœud parmi tous les nœuds qui sont des enfants immédiats du nœud {@code Element}.

Renvois

Content|null : 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
attributeAttributeAttribut à définir.

Renvois

Element : le 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 indiqués, sans espace de noms.

Paramètres

NomTypeDescription
nameStringNom de l'attribut à définir.
valueStringValeur de l'attribut à définir.

Renvois

Element : le 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 spécifiés.

Paramètres

NomTypeDescription
nameStringNom de l'attribut à définir.
valueStringValeur de l'attribut à définir.
namespaceNamespaceEspace de noms de l'attribut à définir.

Renvois

Element : le 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) conjointement avec XmlService.getNamespace(prefix, uri).

Paramètres

NomTypeDescription
nameStringNom local à définir.

Renvois

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

setNamespace(namespace)

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

Paramètres

NomTypeDescription
namespaceNamespaceEspace de noms à définir.

Renvois

Element : le 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 de texte ou des nœuds enfants, cette méthode écrase l'ancien contenu. Pour ajouter ou insérer du contenu, utilisez plutôt addContent(content) ou addContent(index, content).

Paramètres

NomTypeDescription
textStringTexte à définir.

Renvois

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