Class Element

Elemento

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.
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);

Metodi

Metodo	Tipo restituito	Breve descrizione
addContent(content)	Element	Aggiunge il nodo specificato come ultimo nodo secondario del nodo Element.
addContent(index, content)	Element	Inserisce il nodo specificato all'indice specificato tra tutti i nodi che sono figli 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|null	Scollega il nodo dal nodo padre Element.
getAllContent()	Content[]	Recupera tutti i nodi che sono elementi secondari immediati del nodo {@code Element}.
getAttribute(name)	Attribute|null	Recupera l'attributo per questo nodo Element con il nome specificato e senza spazio dei nomi.
getAttribute(name, namespace)	Attribute|null	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|null	Recupera il primo nodo Element con il nome specificato e senza spazio dei nomi che sia un elemento secondario immediato di questo nodo Element.
getChild(name, namespace)	Element|null	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|null	Recupera il valore di testo del nodo con il nome specificato e senza spazio dei nomi, se il nodo è un elemento secondario immediato del nodo Element.
getChildText(name, namespace)	String|null	Recupera il valore di testo del nodo con il nome e lo spazio dei nomi specificati, se il nodo è un figlio immediato del nodo Element.
getChildren()	Element[]	Recupera tutti i nodi Element che sono figli immediati di questo nodo Element, nell'ordine in cui appaiono nel documento.
getChildren(name)	Element[]	Recupera tutti i nodi Element con il nome specificato e senza spazio dei nomi che sono figli 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 specificati che sono figli immediati di questo nodo Element, nell'ordine in cui appaiono nel documento.
getContent(index)	Content|null	Recupera il nodo all'indice specificato tra tutti i nodi che sono figli immediati del nodo {@code Element}.
getContentSize()	Integer	Restituisce il numero di nodi che sono elementi secondari immediati del nodo {@code Element}.
getDescendants()	Content[]	Recupera tutti i nodi che sono elementi secondari diretti o indiretti del nodo {@code Element}, nell'ordine in cui vengono visualizzati 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	Recupera lo spazio dei nomi per il nodo Element.
getNamespace(prefix)	Namespace	Recupera lo spazio dei nomi con il prefisso specificato per il nodo Element.
getParentElement()	Element|null	Restituisce il nodo principale Element del nodo.
getQualifiedName()	String	Recupera il nome locale e il prefisso dello spazio dei nomi del nodo Element, nel formato [namespacePrefix]:[localName].
getText()	String	Recupera il valore di testo del nodo Element.
getValue()	String	Recupera il valore di testo di tutti i nodi secondari diretti o indiretti del nodo, nell'ordine in cui appaiono nel documento.
isAncestorOf(other)	Boolean	Determina se questo nodo Element è un elemento 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.
removeAttribute(attributeName)	Boolean	Rimuove l'attributo per questo nodo Element con il nome specificato e senza 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 figli immediati del nodo {@code Element}.
removeContent(content)	Boolean	Rimuove il nodo specificato, se è un elemento secondario immediato del nodo {@code Element}.
removeContent(index)	Content|null	Rimuove il nodo all'indice specificato tra tutti i nodi che sono figli 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 senza 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)

Aggiunge il nodo specificato come ultimo nodo secondario 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.

Indietro

Element: il nodo Element, per il concatenamento.

---

addContent(index, content)

Inserisce il nodo specificato all'indice specificato tra tutti i nodi che sono figli 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.

Indietro

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}.

Indietro

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

---

detach()

Scollega il nodo dal nodo padre Element. Se il nodo non ha un elemento principale, questo metodo non ha effetto.

Indietro

Content|null: il nodo scollegato.

---

getAllContent()

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

Indietro

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 senza spazio dei nomi. Se non esiste un attributo di questo tipo, questo metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
name	String	Il nome dell'attributo.

Indietro

Attribute|null: l'attributo o null se non esiste un attributo con il nome specificato e nessuno spazio dei nomi.

---

getAttribute(name, namespace)

Recupera l'attributo per questo nodo Element con il nome e lo spazio dei nomi specificati. Se non esiste un nodo di questo tipo, questo metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
name	String	Il nome dell'attributo.
namespace	Namespace	Lo spazio dei nomi dell'attributo.

Indietro

Attribute|null: l'attributo o null se non esiste un 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.

Indietro

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

---

getChild(name)

Recupera il primo nodo Element con il nome specificato e senza spazio dei nomi che sia un elemento secondario immediato di questo nodo Element. Se non esiste un nodo di questo tipo, questo metodo restituisce null.

Parametri

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

Indietro

Element|null: il nodo Element o 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. Se non esiste un nodo di questo tipo, questo metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
name	String	Il nome del nodo secondario Element.
namespace	Namespace	Lo spazio dei nomi del nodo secondario Element.

Indietro

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

---

getChildText(name)

Recupera il valore di testo del nodo con il nome specificato e senza spazio dei nomi, se il nodo è un elemento secondario immediato del nodo Element. Se non esiste un nodo di questo tipo, questo metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
name	String	Il nome del nodo secondario.

Indietro

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

---

getChildText(name, namespace)

Recupera il valore di testo del nodo con il nome e lo spazio dei nomi specificati, se il nodo è un figlio immediato del nodo Element. Se non esiste un nodo di questo tipo, questo metodo restituisce null.

Parametri

Nome	Tipo	Descrizione
name	String	Il nome del nodo secondario.
namespace	Namespace	Lo spazio dei nomi del nodo secondario.

Indietro

String|null: il valore di testo del nodo secondario o 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 figli immediati di questo nodo Element, nell'ordine in cui appaiono nel documento.

Indietro

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

---

getChildren(name)

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

Parametri

Nome	Tipo	Descrizione
name	String	Il nome dei nodi secondari Element.

Indietro

Element[]: un array di tutti i nodi Element con il nome specificato e senza spazio dei nomi che sono figli immediati di questo nodo Element.

---

getChildren(name, namespace)

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

Parametri

Nome	Tipo	Descrizione
name	String	Il nome dei nodi secondari Element.
namespace	Namespace	Lo spazio dei nomi dei nodi secondari Element.

Indietro

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)

Recupera il nodo all'indice specificato tra tutti i nodi che sono figli immediati del nodo {@code Element}. Se non è presente alcun nodo all'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}.

Indietro

Content|null: il nodo o null se non è presente alcun nodo all'indice specificato.

---

getContentSize()

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

Indietro

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

---

getDescendants()

Recupera tutti i nodi che sono elementi secondari diretti o indiretti del nodo {@code Element}, nell'ordine in cui vengono visualizzati nel documento.

Indietro

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

---

getDocument()

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

Indietro

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.

Indietro

String: il nome locale del nodo Element.

---

getNamespace()

Recupera lo spazio dei nomi per il nodo Element.

Indietro

Namespace: lo spazio dei nomi per il nodo Element.

---

getNamespace(prefix)

Recupera 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.

Indietro

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 principale, questo metodo restituisce null.

Indietro

Element|null: il nodo Element principale.

---

getQualifiedName()

Recupera 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().

Indietro

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

---

getText()

Recupera il valore di testo del nodo Element.

Indietro

String: il valore di testo del nodo Element.

---

getValue()

Recupera il valore di testo di tutti i nodi secondari diretti o indiretti del nodo, nell'ordine in cui appaiono nel documento.

Indietro

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

---

isAncestorOf(other)

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

Parametri

Nome	Tipo	Descrizione
other	Element	L'altro nodo Element.

Indietro

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

---

isRootElement()

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

Indietro

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.

Parametri

Nome	Tipo	Descrizione
attribute	Attribute	L'attributo.

Indietro

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 senza spazio dei nomi, se esiste un attributo di questo tipo.

Parametri

Nome	Tipo	Descrizione
attributeName	String	Il nome dell'attributo.

Indietro

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.

Indietro

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

---

removeContent()

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

Indietro

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

---

removeContent(content)

Rimuove il nodo specificato, se è un elemento secondario immediato del nodo {@code 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 rimuovere.

Indietro

Boolean — true se il nodo era un elemento secondario immediato ed è stato rimosso; false in caso contrario.

---

removeContent(index)

Rimuove il nodo all'indice specificato tra tutti i nodi che sono figli immediati del nodo {@code Element}. Se non è presente alcun nodo all'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}.

Indietro

Content|null: il nodo rimosso o null se non è presente alcun nodo all'indice specificato.

---

setAttribute(attribute)

Imposta l'attributo specificato per questo nodo Element.

Parametri

Nome	Tipo	Descrizione
attribute	Attribute	L'attributo da impostare.

Indietro

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 senza spazio dei nomi.

Parametri

Nome	Tipo	Descrizione
name	String	Il nome dell'attributo da impostare.
value	String	Il valore dell'attributo da impostare.

Indietro

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.

Indietro

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.

Indietro

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.

Indietro

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.

Indietro

Element: il nodo Element, per il concatenamento.