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

MetodoTipo restituitoBreve descrizione
addContent(content)ElementAggiungi il nodo specificato come ultimo nodo figlio del nodo Element.
addContent(index, content)ElementInserisce il nodo specificato nell'indice specificato tra tutti i nodi figlio immediati del Element nodo.
cloneContent()Content[]Crea copie non collegate di tutti i nodi secondari immediati del nodo {@code Element}.
detach()ContentStacca il nodo dal relativo nodo Element principale.
getAllContent()Content[]Ottiene tutti i nodi secondari immediati del nodo {@code Element}.
getAttribute(name)AttributeOttiene l'attributo per questo nodo Element con il nome specificato e nessuno spazio dei nomi.
getAttribute(name, namespace)AttributeRecupera 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)ElementOttiene il primo nodo Element con il nome specificato e nessuno spazio dei nomi che è immediato figlio di questo nodo Element.
getChild(name, namespace)ElementOttiene il primo nodo Element con il nome e lo spazio dei nomi specificati. figlio di questo nodo Element.
getChildText(name)StringOttiene il valore di testo del nodo con il nome specificato e senza spazio dei nomi, se il nodo è figlio immediato del nodo Element.
getChildText(name, namespace)StringOttiene il valore di testo del nodo con il nome e lo spazio dei nomi specificati, se il nodo è una figlio del nodo Element.
getChildren()Element[]Recupera tutti i nodi Element secondari di questo nodo Element, in nell'ordine in cui appaiono nel documento.
getChildren(name)Element[]Ottiene 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 vengono visualizzati nel documento.
getChildren(name, namespace)Element[]Ottiene tutti i nodi Element con il nome e lo spazio dei nomi specificati che sono elementi secondari immediati di questo nodo Element, nell'ordine in cui appaiono nel documento.
getContent(index)ContentRestituisce il nodo in corrispondenza dell'indice specificato tra tutti i nodi figlio immediati del Nodo {@code Element}.
getContentSize()IntegerRestituisce il numero di nodi secondari immediati del nodo {@code Element}.
getDescendants()Content[]Ottiene tutti i nodi che sono figli diretti o indiretti del nodo {@code Element}, nell'ordine in cui vengono visualizzate nel documento.
getDocument()DocumentOttiene il documento XML che contiene il nodo {@code Element}.
getName()StringOttiene il nome locale del nodo Element.
getNamespace()NamespaceOttiene lo spazio dei nomi per il nodo Element.
getNamespace(prefix)NamespaceRecupera lo spazio dei nomi con il prefisso specificato per il nodo Element.
getParentElement()ElementOttiene il nodo principale Element del nodo.
getQualifiedName()StringOttiene il nome locale e il prefisso dello spazio dei nomi del nodo Element, nel formato [namespacePrefix]:[localName].
getText()StringOttiene il valore di testo del nodo Element.
getValue()StringRestituisce il valore testo di tutti i nodi che sono figli diretti o indiretti del nodo, nell'ordine appaiono nel documento.
isAncestorOf(other)BooleanDetermina se questo nodo Element è un elemento padre diretto o indiretto di un determinato nodo Element.
isRootElement()BooleanDetermina se il nodo Element è il nodo radice del documento.
removeAttribute(attribute)BooleanRimuove l'attributo specificato per questo nodo Element, se esiste.
removeAttribute(attributeName)BooleanRimuove l'attributo per questo nodo Element con il nome specificato e senza spazio dei nomi, se di un attributo di questo tipo.
removeAttribute(attributeName, namespace)BooleanRimuove l'attributo per questo nodo Element con il nome e lo spazio dei nomi specificati, se presenti esiste un attributo.
removeContent()Content[]Rimuove tutti i nodi secondari immediati del nodo {@code Element}.
removeContent(content)BooleanRimuove il nodo specificato, se è un nodo secondario immediato del nodo {@code Element}.
removeContent(index)ContentRimuove il nodo in corrispondenza dell'indice specificato tra tutti i nodi figlio immediati del Nodo {@code Element}.
setAttribute(attribute)ElementImposta l'attributo specificato per questo nodo Element.
setAttribute(name, value)ElementImposta l'attributo per questo nodo Element con il nome e il valore specificati, senza spazio dei nomi.
setAttribute(name, value, namespace)ElementImposta l'attributo per questo nodo Element con il nome, il valore e lo spazio dei nomi specificati.
setName(name)ElementImposta il nome locale del nodo Element.
setNamespace(namespace)ElementImposta lo spazio dei nomi per il nodo Element.
setText(text)ElementImposta il valore di testo del nodo Element.

Documentazione dettagliata

addContent(content)

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

Parametri

NomeTipoDescrizione
contentContentil nodo per aggiungere

Invio

Element: il nodo Element, per il concatenamento


addContent(index, content)

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

Parametri

NomeTipoDescrizione
indexIntegerl'indice in cui inserire il nodo tra tutti i nodi figlio immediati del nodo Element
contentContentil nodo per inserire

Invio

Element: il nodo Element, per il concatenamento


cloneContent()

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

Invio

Content[]: un array di copie non collegate di tutti i nodi figlio immediati dello Nodo {@code Element}


detach()

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

Invio

Content: il nodo scollegato


getAllContent()

Ottiene tutti i nodi secondari immediati del nodo {@code Element}.

Invio

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


getAttribute(name)

Ottiene l'attributo per questo nodo Element con il nome specificato e nessuno spazio dei nomi. Se ci sono non è un attributo di questo tipo, questo metodo restituisce null.

Parametri

NomeTipoDescrizione
nameStringil nome dell'attributo

Invio

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


getAttribute(name, namespace)

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

Parametri

NomeTipoDescrizione
nameStringil nome dell'attributo
namespaceNamespacelo spazio dei nomi dell'attributo

Invio

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


getAttributes()

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

Invio

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


getChild(name)

Ottiene il primo nodo Element con il nome specificato e nessuno spazio dei nomi che è immediato figlio di questo nodo Element. Se questo nodo non è presente, questo metodo restituisce null.

Parametri

NomeTipoDescrizione
nameStringil nome del nodo figlio Element

Invio

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


getChild(name, namespace)

Ottiene il primo nodo Element con il nome e lo spazio dei nomi specificati. figlio di questo nodo Element. Se questo nodo non è presente, questo metodo restituisce null.

Parametri

NomeTipoDescrizione
nameStringil nome del nodo figlio Element
namespaceNamespacelo spazio dei nomi del nodo figlio Element

Invio

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


getChildText(name)

Ottiene il valore di testo del nodo con il nome specificato e senza spazio dei nomi, se il nodo è figlio immediato del nodo Element. Se questo nodo non è presente, questo metodo restituisce null.

Parametri

NomeTipoDescrizione
nameStringil nome del nodo figlio

Invio

String: il valore di testo del nodo figlio o null se non esiste un nodo figlio immediato con il nome specificato e senza spazio dei nomi


getChildText(name, namespace)

Ottiene il valore di testo del nodo con il nome e lo spazio dei nomi specificati, se il nodo è una figlio del nodo Element. Se questo nodo non è presente, questo metodo restituisce null.

Parametri

NomeTipoDescrizione
nameStringil nome del nodo figlio
namespaceNamespacelo spazio dei nomi del nodo figlio

Invio

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


getChildren()

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

Invio

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


getChildren(name)

Ottiene 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 vengono visualizzati nel documento.

Parametri

NomeTipoDescrizione
nameStringil nome dei nodi figlio Element

Invio

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


getChildren(name, namespace)

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

Parametri

NomeTipoDescrizione
nameStringil nome dei nodi figlio Element
namespaceNamespacelo spazio dei nomi dei nodi figlio Element

Invio

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


getContent(index)

Restituisce il nodo in corrispondenza dell'indice specificato tra tutti i nodi figlio immediati del Nodo {@code Element}. Se non sono presenti nodi nell'indice specificato, questo metodo restituisce null.

Parametri

NomeTipoDescrizione
indexIntegerl'indice del nodo tra tutti i nodi secondari immediati del Nodo {@code Element}

Invio

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


getContentSize()

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

Invio

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


getDescendants()

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

Invio

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


getDocument()

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

Invio

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


getName()

Ottiene il nome locale del nodo Element. Se il nodo ha un prefisso dello spazio dei nomi, usa getQualifiedName() o getNamespace().Da getPrefix() a recupera il prefisso.

Invio

String: il nome locale del nodo Element


getNamespace()

Ottiene lo spazio dei nomi per il nodo Element.

Invio

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

NomeTipoDescrizione
prefixStringil prefisso dello spazio dei nomi

Invio

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


getParentElement()

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

Invio

Element: il nodo principale Element


getQualifiedName()

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

Invio

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


getText()

Ottiene il valore di testo del nodo Element.

Invio

String: il valore di testo del nodo Element


getValue()

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

Invio

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 elemento padre diretto o indiretto di un determinato nodo Element.

Parametri

NomeTipoDescrizione
otherElementl'altro nodo Element

Invio

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


isRootElement()

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

Invio

Boolean: true se il nodo Element è il nodo principale del documento; false se non


removeAttribute(attribute)

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

Parametri

NomeTipoDescrizione
attributeAttributel'attributo

Invio

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 di un attributo di questo tipo.

Parametri

NomeTipoDescrizione
attributeNameStringil nome dell'attributo

Invio

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 presenti esiste un attributo.

Parametri

NomeTipoDescrizione
attributeNameStringil nome dell'attributo
namespaceNamespacelo spazio dei nomi dell'attributo

Invio

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


removeContent()

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

Invio

Content[]: un array di tutti i nodi che erano secondari immediati del nodo {@code Element} prima di sono stati 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 corrisponde a un tipo elencato in ContentType.

Parametri

NomeTipoDescrizione
contentContentil nodo per rimuovere

Invio

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


removeContent(index)

Rimuove il nodo in corrispondenza dell'indice specificato tra tutti i nodi figlio immediati del Nodo {@code Element}. Se non sono presenti nodi nell'indice specificato, questo metodo restituisce null.

Parametri

NomeTipoDescrizione
indexIntegerl'indice del nodo tra tutti i nodi secondari immediati del Nodo {@code Element}

Invio

Content: il nodo che è stato rimosso o null se non sono presenti nodi nell'indice specificato


setAttribute(attribute)

Imposta l'attributo specificato per questo nodo Element.

Parametri

NomeTipoDescrizione
attributeAttributel'attributo per impostare

Invio

Element: il nodo Element, per il concatenamento


setAttribute(name, value)

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

Parametri

NomeTipoDescrizione
nameStringil nome dell'attributo da impostare
valueStringil valore dell'attributo da impostare

Invio

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

NomeTipoDescrizione
nameStringil nome dell'attributo da impostare
valueStringil valore dell'attributo da impostare
namespaceNamespacelo spazio dei nomi dell'attributo

Invio

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) in combinazione con XmlService.getNamespace(prefix, uri).

Parametri

NomeTipoDescrizione
nameStringil nome locale da impostare

Invio

Element: il nodo Element, per il concatenamento


setNamespace(namespace)

Imposta lo spazio dei nomi per il nodo Element.

Parametri

NomeTipoDescrizione
namespaceNamespacelo spazio dei nomi per impostare

Invio

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 figlio, questo metodo sovrascrive i contenuti precedenti. Per aggiungere o inserire contenuti, usa addContent(content) o addContent(index, content).

Parametri

NomeTipoDescrizione
textStringil testo da impostare

Invio

Element: il nodo Element, per il concatenamento