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.
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`	Collega il nodo specificato come ultimo elemento secondario del nodo `Element`.
`addContent(index, content)`	`Element`	Inserisce il nodo specificato nell'indice specificato tra tutti i nodi figli immediati del nodo `Element`.
`cloneContent()`	`Content[]`	Crea copie non associate di tutti i nodi secondari immediati del nodo {@code Element}.
`detach()`	`Content`	Scollega il nodo dal nodo `Element` principale.
`getAllContent()`	`Content[]`	Recupera tutti i nodi secondari immediati del nodo {@code Element}.
`getAttribute(name)`	`Attribute`	Recupera l'attributo per questo nodo `Element` con il nome specificato e senza 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`	Recupera il primo nodo `Element` con il nome specificato e senza spazio dei nomi che è un figlio 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 figlio immediato di questo nodo `Element`.
`getChildText(name)`	`String`	Recupera il valore di testo del nodo con il nome specificato e senza spazio dei nomi, se il nodo è un figlio immediato del nodo `Element`.
`getChildText(name, namespace)`	`String`	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 elementi secondari 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 diretti di questo nodo `Element`, nell'ordine in cui appaiono nel documento.
`getContent(index)`	`Content`	Recupera il nodo all'indice specificato tra tutti i nodi secondari immediati del nodo {@code Element}.
`getContentSize()`	`Integer`	Restituisce il numero di nodi secondari immediati del nodo {@code Element}.
`getDescendants()`	`Content[]`	Recupera tutti i nodi secondari diretti o indiretti del nodo {@code Element}, nell'ordine in cui compaiono nel documento.
`getDocument()`	`Document`	Recupera il documento XML contenente il nodo {@code Element}.
`getName()`	`String`	Recupera 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`	Recupera il nodo `Element` principale 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 che sono figli diretti o indiretti del nodo, nell'ordine in cui appaiono nel documento.
`isAncestorOf(other)`	`Boolean`	Determina se questo nodo `Element` è un nodo principale 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 un attributo di questo tipo esiste.
`removeContent()`	`Content[]`	Rimuove tutti i nodi figli 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 all'indice specificato tra tutti i nodi 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, il valore e lo spazio dei nomi specificati.
`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)`

Collega il nodo specificato come ultimo elemento secondario del nodo 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 aggiungere

Invio

Element: il nodo Element, per l'accodamento

`addContent(index, content)`

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

Parametri

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

Invio

Element: il nodo Element per l'accodamento

`cloneContent()`

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

Invio

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

`detach()`

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

Invio

Content: il nodo scollegato

`getAllContent()`

Recupera 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)`

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

Invio

Attribute: l'attributo o null se non esiste un attributo con il nome specificato e non è presente alcuno 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, il metodo restituisce null.

Parametri

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

Invio

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

Invio

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

Parametri

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

Invio

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

`getChild(name, namespace)`

Recupera il primo nodo Element con il nome e lo spazio dei nomi specificati che è un figlio immediato di questo nodo Element. Se non esiste un nodo di questo tipo, il 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`

Invio

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

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)`

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

Parametri

Nome	Tipo	Descrizione
`name`	`String`	il nome del nodo secondario
`namespace`	`Namespace`	Lo spazio dei nomi del nodo secondario

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 che sono elementi secondari immediati di questo nodo Element, nell'ordine in cui appaiono nel documento.

Invio

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`

Invio

Element[]: un array di tutti i nodi Element con il nome specificato e senza 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 specificati che sono figli diretti 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`

Invio

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

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

Invio

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

`getDocument()`

Recupera il documento XML contenente il nodo {@code Element}.

Invio

Document: il documento contenente il nodo {@code Element}

`getName()`

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

Invio

String: il nome locale del nodo Element

`getNamespace()`

Recupera 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

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

Invio

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

`getParentElement()`

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

Invio

Element: 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().

Invio

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.

Invio

String: il valore del testo del nodo Element

`getValue()`

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

Invio

String: il valore di testo di tutti i nodi secondari diretti o indiretti del nodo

`isAncestorOf(other)`

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

Parametri

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

Invio

Boolean - true se questo nodo Element è un nodo principale diretto o indiretto del nodo Element specificato; 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 no

`removeAttribute(attribute)`

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

Parametri

Nome	Tipo	Descrizione
`attribute`	`Attribute`	l'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 esiste un attributo di questo tipo.

Parametri

Nome	Tipo	Descrizione
`attributeName`	`String`	il 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 un attributo di questo tipo esiste.

Parametri

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

Invio

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

`removeContent()`

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

Invio

Content[]: un array di tutti i nodi che erano figli diretti 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

Invio

Boolean - true se il nodo era un nodo figlio diretto ed è stato rimosso; false in caso contrario

`removeContent(index)`

Rimuove il nodo all'indice specificato tra tutti i nodi figli 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 secondari immediati del nodo {@code Element}

Invio

Content: il nodo rimosso o 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

Invio

Element: il nodo Element per l'accodamento

`setAttribute(name, value)`

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

Invio

Element: il nodo Element per l'accodamento

`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

Invio

Element: il nodo Element per l'accodamento

`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

Invio

Element: il nodo Element per l'accodamento

`setNamespace(namespace)`

Imposta lo spazio dei nomi per il nodo Element.

Parametri

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

Invio

Element: il nodo Element per l'accodamento

`setText(text)`

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

Parametri

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

Invio

Element: il nodo Element per l'accodamento