Questa pagina è stata tradotta dall'API Cloud Translation.

Class Element

Una rappresentazione di un nodo 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);

Metodi

Metodo	Tipo restituito	Breve descrizione
`addContent(content)`	`Element`	Accoda il nodo specificato come ultimo nodo figlio del nodo `Element`.
`addContent(index, content)`	`Element`	Inserisce il nodo specificato nell'indice specificato tra tutti i nodi secondari immediati del nodo `Element`.
`cloneContent()`	`Content[]`	Crea copie non collegate di tutti i nodi che sono elementi secondari immediati del nodo {@code Element}.
`detach()`	`Content`	Stacca il nodo dal nodo `Element` padre.
`getAllContent()`	`Content[]`	Restituisce tutti i nodi che sono elementi secondari immediati del nodo {@code Element}.
`getAttribute(name)`	`Attribute`	Recupera l'attributo per questo nodo `Element` con il nome specificato e nessuno spazio dei nomi.
`getAttribute(name, namespace)`	`Attribute`	Recupera l'attributo per questo nodo `Element` con il nome e lo spazio dei nomi specificati.
`getAttributes()`	`Attribute[]`	Recupera tutti gli attributi per questo nodo `Element`, nell'ordine in cui appaiono nel documento.
`getChild(name)`	`Element`	Restituisce il primo nodo `Element` con il nome specificato e nessuno spazio dei nomi che è un elemento secondario immediato di questo nodo `Element`.
`getChild(name, namespace)`	`Element`	Recupera il primo nodo `Element` con il nome e lo spazio dei nomi specificati, che è un elemento secondario immediato di questo nodo `Element`.
`getChildText(name)`	`String`	Restituisce il valore di testo del nodo con il nome specificato e nessuno spazio dei nomi, se il nodo è un nodo figlio immediato del nodo `Element`.
`getChildText(name, namespace)`	`String`	Restituisce il valore di testo del nodo con il nome e lo spazio dei nomi specificati, se il nodo è un nodo secondario immediato del nodo `Element`.
`getChildren()`	`Element[]`	Recupera tutti i nodi `Element` che sono elementi secondari immediati di questo nodo `Element`, nell'ordine in cui appaiono nel documento.
`getChildren(name)`	`Element[]`	Restituisce tutti i nodi `Element` con il nome specificato e nessuno spazio dei nomi che sono elementi secondari immediati di questo nodo `Element`, nell'ordine in cui appaiono nel documento.
`getChildren(name, namespace)`	`Element[]`	Recupera tutti i nodi `Element` con il nome e lo spazio dei nomi dati che sono elementi secondari immediati di questo nodo `Element`, nell'ordine in cui appaiono nel documento.
`getContent(index)`	`Content`	Restituisce il nodo nell'indice specificato tra tutti i nodi che sono elementi secondari immediati del nodo {@code Element}.
`getContentSize()`	`Integer`	Restituisce il numero di nodi che sono elementi secondari immediati del nodo {@code Element}.
`getDescendants()`	`Content[]`	Restituisce tutti i nodi che sono figli diretti o indiretti del nodo {@code Element}, nell'ordine in cui appaiono nel documento.
`getDocument()`	`Document`	Recupera il documento XML che contiene il nodo {@code Element}.
`getName()`	`String`	Restituisce il nome locale del nodo `Element`.
`getNamespace()`	`Namespace`	Ottiene lo spazio dei nomi per il nodo `Element`.
`getNamespace(prefix)`	`Namespace`	Restituisce lo spazio dei nomi con il prefisso specificato per il nodo `Element`.
`getParentElement()`	`Element`	Restituisce il nodo principale `Element` del nodo.
`getQualifiedName()`	`String`	Restituisce il nome locale e il prefisso dello spazio dei nomi del nodo `Element`, nel formato `[namespacePrefix]:[localName]`.
`getText()`	`String`	Restituisce il valore di testo del nodo `Element`.
`getValue()`	`String`	Restituisce il valore di testo di tutti i nodi che sono figli diretti o indiretti del nodo, nell'ordine in cui appaiono nel documento.
`isAncestorOf(other)`	`Boolean`	Determina se questo nodo `Element` è un padre diretto o indiretto di un determinato nodo `Element`.
`isRootElement()`	`Boolean`	Determina se il nodo `Element` è il nodo radice del documento.
`removeAttribute(attribute)`	`Boolean`	Rimuove l'attributo specificato per questo nodo `Element`, se esiste un attributo di questo tipo.
`removeAttribute(attributeName)`	`Boolean`	Rimuove l'attributo per questo nodo `Element` con il nome specificato e nessuno spazio dei nomi, se esiste un attributo di questo tipo.
`removeAttribute(attributeName, namespace)`	`Boolean`	Rimuove l'attributo per questo nodo `Element` con il nome e lo spazio dei nomi specificati, se esiste un attributo di questo tipo.
`removeContent()`	`Content[]`	Rimuove tutti i nodi che sono elementi secondari immediati del nodo {@code Element}.
`removeContent(content)`	`Boolean`	Rimuove il nodo specificato, se è un nodo secondario immediato del nodo {@code Element}.
`removeContent(index)`	`Content`	Rimuove il nodo nell'indice specificato tra tutti i nodi secondari immediati del nodo {@code Element}.
`setAttribute(attribute)`	`Element`	Imposta l'attributo specificato per questo nodo `Element`.
`setAttribute(name, value)`	`Element`	Imposta l'attributo per questo nodo `Element` con il nome e il valore specificati e nessuno spazio dei nomi.
`setAttribute(name, value, namespace)`	`Element`	Imposta l'attributo per questo nodo `Element` con il nome, il valore e lo spazio dei nomi specificati.
`setName(name)`	`Element`	Imposta il nome locale del nodo `Element`.
`setNamespace(namespace)`	`Element`	Imposta lo spazio dei nomi per il nodo `Element`.
`setText(text)`	`Element`	Imposta il valore di testo del nodo `Element`.

Documentazione dettagliata

`addContent(content)`

Accoda il nodo specificato come ultimo nodo figlio del nodo Element. L'argomento content può essere un oggetto Element o qualsiasi oggetto nodo che corrisponde a un tipo elencato in ContentType.

Parametri

Nome	Tipo	Descrizione
`content`	`Content`	il nodo da aggiungere

Ritorni

Element: il nodo Element, per il concatenamento

`addContent(index, content)`

Inserisce il nodo specificato nell'indice specificato tra tutti i nodi secondari immediati del nodo Element. L'argomento content può essere un oggetto Element o qualsiasi oggetto nodo che corrisponde a un tipo elencato in ContentType.

Parametri

Nome	Tipo	Descrizione
`index`	`Integer`	l'indice in cui inserire il nodo tra tutti i nodi che sono elementi secondari immediati del nodo `Element`
`content`	`Content`	il nodo da inserire

Ritorni

Element: il nodo Element, per il concatenamento

`cloneContent()`

Crea copie non collegate di tutti i nodi che sono elementi secondari immediati del nodo {@code Element}.

Ritorni

Content[]: un array di copie non collegate di tutti i nodi che sono elementi secondari immediati del nodo {@code Element}

`detach()`

Stacca il nodo dal nodo Element padre. Se il nodo non ha un elemento padre, questo metodo non ha alcun effetto.

Ritorni

Content: il nodo scollegato

`getAllContent()`

Restituisce tutti i nodi che sono elementi secondari immediati del nodo {@code Element}.

Ritorni

Content[]: un array di tutti i nodi che sono elementi secondari immediati del nodo {@code Element}

`getAttribute(name)`

Recupera l'attributo per questo nodo Element con il nome specificato e nessuno spazio dei nomi. In assenza di questo attributo, il metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome dell'attributo

Ritorni

Attribute: l'attributo o null se non esiste un attributo con il nome specificato né uno spazio dei nomi.

`getAttribute(name, namespace)`

Recupera l'attributo per questo nodo Element con il nome e lo spazio dei nomi specificati. In assenza di questo nodo, il metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome dell'attributo
`namespace`	`Namespace`	lo spazio dei nomi dell'attributo

Ritorni

Attribute: l'attributo o null se non è presente alcun attributo con il nome e lo spazio dei nomi specificati

`getAttributes()`

Recupera tutti gli attributi per questo nodo Element, nell'ordine in cui appaiono nel documento.

Ritorni

Attribute[]: un array di tutti gli attributi per questo nodo Element

`getChild(name)`

Restituisce il primo nodo Element con il nome specificato e nessuno spazio dei nomi che è un elemento secondario immediato di questo nodo Element. In assenza di tale nodo, il metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	Il nome del nodo `Element` secondario

Ritorni

Element: il nodo Element oppure null se non esiste un nodo Element secondario immediato con il nome specificato e nessuno spazio dei nomi

`getChild(name, namespace)`

Recupera il primo nodo Element con il nome e lo spazio dei nomi specificati, che è un elemento secondario immediato di questo nodo Element. In assenza di tale nodo, il metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	Il nome del nodo `Element` secondario
`namespace`	`Namespace`	lo spazio dei nomi del nodo `Element` figlio

Ritorni

Element: il nodo Element oppure null se non esiste un nodo Element secondario immediato con il nome e lo spazio dei nomi specificati

`getChildText(name)`

Restituisce il valore di testo del nodo con il nome specificato e nessuno spazio dei nomi, se il nodo è un nodo figlio immediato del nodo Element. In assenza di questo nodo, il metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome del nodo figlio

Ritorni

String: il valore di testo del nodo figlio oppure null se non esiste un nodo secondario immediato con il nome specificato né uno spazio dei nomi

`getChildText(name, namespace)`

Restituisce il valore di testo del nodo con il nome e lo spazio dei nomi specificati, se il nodo è un nodo secondario immediato del nodo Element. In assenza di tale nodo, il metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome del nodo figlio
`namespace`	`Namespace`	lo spazio dei nomi del nodo figlio

Ritorni

String: il valore di testo del nodo figlio oppure null se non esiste un nodo secondario immediato con il nome e lo spazio dei nomi specificati

`getChildren()`

Recupera tutti i nodi Element che sono elementi secondari immediati di questo nodo Element, nell'ordine in cui appaiono nel documento.

Ritorni

Element[]: un array di tutti i nodi Element che sono elementi secondari immediati di questo nodo Element

`getChildren(name)`

Restituisce tutti i nodi Element con il nome specificato e nessuno spazio dei nomi che sono elementi secondari immediati di questo nodo Element, nell'ordine in cui appaiono nel documento.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome dei nodi `Element` secondari

Ritorni

Element[]: un array di tutti i nodi Element con il nome specificato e nessuno spazio dei nomi che sono elementi secondari immediati di questo nodo Element

`getChildren(name, namespace)`

Recupera tutti i nodi Element con il nome e lo spazio dei nomi dati che sono elementi secondari immediati di questo nodo Element, nell'ordine in cui appaiono nel documento.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome dei nodi `Element` secondari
`namespace`	`Namespace`	lo spazio dei nomi dei nodi `Element` secondari

Ritorni

Element[]: un array di tutti i nodi Element con il nome e lo spazio dei nomi specificati che sono elementi secondari immediati di questo nodo Element

`getContent(index)`

Restituisce il nodo nell'indice specificato tra tutti i nodi che sono elementi secondari immediati del nodo {@code Element}. Se non è presente alcun nodo nell'indice specificato, questo metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
`index`	`Integer`	l'indice del nodo tra tutti i nodi che sono elementi secondari immediati del nodo {@code Element}

Ritorni

Content: il nodo oppure null se non è presente alcun nodo nell'indice specificato

`getContentSize()`

Restituisce il numero di nodi che sono elementi secondari immediati del nodo {@code Element}.

Ritorni

Integer: il numero di nodi che sono elementi secondari immediati del nodo {@code Element}

`getDescendants()`

Restituisce tutti i nodi che sono figli diretti o indiretti del nodo {@code Element}, nell'ordine in cui appaiono nel documento.

Ritorni

Content[]: un array di tutti i nodi che sono secondari diretti o indiretti del nodo {@code Element}

`getDocument()`

Recupera il documento XML che contiene il nodo {@code Element}.

Ritorni

Document: il documento che contiene il nodo {@code Element}.

`getName()`

Restituisce il nome locale del nodo Element. Se il nodo ha un prefisso dello spazio dei nomi, utilizza getQualifiedName() o getNamespace().getPrefix() per ottenere il prefisso.

Ritorni

String: il nome locale del nodo Element

`getNamespace()`

Ottiene lo spazio dei nomi per il nodo Element.

Ritorni

Namespace: lo spazio dei nomi per il nodo Element

`getNamespace(prefix)`

Restituisce lo spazio dei nomi con il prefisso specificato per il nodo Element.

Parametri

Nome	Tipo	Descrizione
`prefix`	`String`	il prefisso per lo spazio dei nomi

Ritorni

Namespace: lo spazio dei nomi con il prefisso specificato per il nodo Element

`getParentElement()`

Restituisce il nodo principale Element del nodo. Se il nodo non ha un elemento padre, questo metodo restituisce null.

Ritorni

Element: il nodo Element padre

`getQualifiedName()`

Restituisce il nome locale e il prefisso dello spazio dei nomi del nodo Element, nel formato [namespacePrefix]:[localName]. Se il nodo non ha un prefisso dello spazio dei nomi, utilizza getName().

Ritorni

String: il nome locale e il prefisso dello spazio dei nomi del nodo Element, nel formato [namespacePrefix]:[localName]

`getText()`

Restituisce il valore di testo del nodo Element.

Ritorni

String: il valore di testo del nodo Element

`getValue()`

Restituisce il valore di testo di tutti i nodi che sono figli diretti o indiretti del nodo, nell'ordine in cui appaiono nel documento.

Ritorni

String: il valore di testo di tutti i nodi che sono figli diretti o indiretti del nodo

`isAncestorOf(other)`

Determina se questo nodo Element è un padre diretto o indiretto di un determinato nodo Element.

Parametri

Nome	Tipo	Descrizione
`other`	`Element`	l'altro nodo `Element`

Ritorni

Boolean: true se questo nodo Element è un padre diretto o indiretto del nodo Element specificato; false in caso contrario

`isRootElement()`

Determina se il nodo Element è il nodo radice del documento.

Ritorni

Boolean: true se il nodo Element è il nodo radice del documento; false in caso contrario

`removeAttribute(attribute)`

Rimuove l'attributo specificato per questo nodo Element, se esiste un attributo di questo tipo.

Parametri

Nome	Tipo	Descrizione
`attribute`	`Attribute`	l'attributo

Ritorni

Boolean: true se l'attributo esisteva ed è stato rimosso; false in caso contrario

`removeAttribute(attributeName)`

Rimuove l'attributo per questo nodo Element con il nome specificato e nessuno spazio dei nomi, se esiste un attributo di questo tipo.

Parametri

Nome	Tipo	Descrizione
`attributeName`	`String`	il nome dell'attributo

Ritorni

Boolean: true se l'attributo esisteva ed è stato rimosso; false in caso contrario

`removeAttribute(attributeName, namespace)`

Rimuove l'attributo per questo nodo Element con il nome e lo spazio dei nomi specificati, se esiste un attributo di questo tipo.

Parametri

Nome	Tipo	Descrizione
`attributeName`	`String`	il nome dell'attributo
`namespace`	`Namespace`	lo spazio dei nomi dell'attributo

Ritorni

Boolean: true se l'attributo esisteva ed è stato rimosso; false in caso contrario

`removeContent()`

Rimuove tutti i nodi che sono elementi secondari immediati del nodo {@code Element}.

Ritorni

Content[]: un array di tutti i nodi che erano elementi secondari immediati del nodo {@code Element} prima di essere rimossi

`removeContent(content)`

Rimuove il nodo specificato, se è un nodo secondario immediato del nodo {@code Element}. L'argomento content può essere un oggetto Element o qualsiasi oggetto nodo che corrisponda a un tipo elencato in ContentType.

Parametri

Nome	Tipo	Descrizione
`content`	`Content`	il nodo da rimuovere

Ritorni

Boolean: true se il nodo era un nodo secondario ed è stato rimosso; in caso contrario false

`removeContent(index)`

Rimuove il nodo nell'indice specificato tra tutti i nodi secondari immediati del nodo {@code Element}. Se non è presente alcun nodo nell'indice specificato, questo metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
`index`	`Integer`	l'indice del nodo tra tutti i nodi che sono elementi secondari immediati del nodo {@code Element}

Ritorni

Content: il nodo rimosso oppure null se non è presente alcun nodo nell'indice specificato.

`setAttribute(attribute)`

Imposta l'attributo specificato per questo nodo Element.

Parametri

Nome	Tipo	Descrizione
`attribute`	`Attribute`	l'attributo da impostare

Ritorni

Element: il nodo Element, per il concatenamento

`setAttribute(name, value)`

Imposta l'attributo per questo nodo Element con il nome e il valore specificati e nessuno spazio dei nomi.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome dell'attributo da impostare
`value`	`String`	il valore dell'attributo da impostare

Ritorni

Element: il nodo Element, per il concatenamento

`setAttribute(name, value, namespace)`

Imposta l'attributo per questo nodo Element con il nome, il valore e lo spazio dei nomi specificati.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome dell'attributo da impostare
`value`	`String`	il valore dell'attributo da impostare
`namespace`	`Namespace`	lo spazio dei nomi dell'attributo da impostare

Ritorni

Element: il nodo Element, per il concatenamento

`setName(name)`

Imposta il nome locale del nodo Element. Per impostare un prefisso dello spazio dei nomi per il nodo, utilizza setNamespace(namespace) insieme a XmlService.getNamespace(prefix, uri).

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome locale da impostare

Ritorni

Element: il nodo Element, per il concatenamento

`setNamespace(namespace)`

Imposta lo spazio dei nomi per il nodo Element.

Parametri

Nome	Tipo	Descrizione
`namespace`	`Namespace`	lo spazio dei nomi da impostare

Ritorni

Element: il nodo Element, per il concatenamento

`setText(text)`

Imposta il valore di testo del nodo Element. Se il nodo contiene già un valore di testo o nodi secondari, questo metodo sovrascrive i contenuti precedenti. Per aggiungere o inserire contenuti, utilizza addContent(content) o addContent(index, content).

Parametri

Nome	Tipo	Descrizione
`text`	`String`	il testo da impostare

Ritorni

Element: il nodo Element, per il concatenamento