Class Element

Elemento

Representación de un nodo Element XML.

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
addContent(content)ElementAgrega el nodo dado como el último elemento secundario del nodo Element.
addContent(index, content)ElementInserta el nodo determinado en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del nodo Element.
cloneContent()Content[]Crea copias sin adjuntar de todos los nodos que son secundarios inmediatos del nodo {@code Element}.
detach()ContentDesconecta el nodo de su nodo superior Element.
getAllContent()Content[]Obtiene todos los nodos que son secundarios inmediatos del nodo {@code Element}.
getAttribute(name)AttributeObtiene el atributo para este nodo Element con el nombre dado y sin espacio de nombres.
getAttribute(name, namespace)AttributeObtiene el atributo de este nodo Element con el nombre y el espacio de nombres determinados.
getAttributes()Attribute[]Obtiene todos los atributos de este nodo Element, en el orden en que aparecen en el documento.
getChild(name)ElementObtiene el primer nodo de Element con el nombre dado y sin espacio de nombres que sea un elemento secundario inmediato de este nodo Element.
getChild(name, namespace)ElementObtiene el primer nodo Element con el nombre y el espacio de nombres dados, que es un elemento secundario inmediato de este nodo Element.
getChildText(name)StringObtiene el valor de texto del nodo con el nombre dado y sin espacio de nombres, si el nodo es un elemento secundario inmediato del nodo Element.
getChildText(name, namespace)StringObtiene el valor de texto del nodo con el nombre y el espacio de nombres determinados, si el nodo es un elemento secundario inmediato del nodo Element.
getChildren()Element[]Obtiene todos los nodos Element que son elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.
getChildren(name)Element[]Obtiene todos los nodos Element con el nombre dado y ningún espacio de nombres que sean elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.
getChildren(name, namespace)Element[]Obtiene todos los nodos Element con el nombre y el espacio de nombres determinados que son elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.
getContent(index)ContentObtiene el nodo en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}.
getContentSize()IntegerObtiene la cantidad de nodos que son secundarios inmediatos del nodo {@code Element}.
getDescendants()Content[]Obtiene todos los nodos que son secundarios directos o indirectos del nodo {@code Element}, en el orden en que aparecen en el documento.
getDocument()DocumentObtiene el documento XML que contiene el nodo {@code Element}.
getName()StringObtiene el nombre local del nodo Element.
getNamespace()NamespaceObtiene el espacio de nombres para el nodo Element.
getNamespace(prefix)NamespaceObtiene el espacio de nombres con el prefijo dado para el nodo Element.
getParentElement()ElementObtiene el nodo Element superior del nodo.
getQualifiedName()StringObtiene el nombre local y el prefijo del espacio de nombres del nodo Element, con el formato [namespacePrefix]:[localName].
getText()StringObtiene el valor de texto del nodo Element.
getValue()StringObtiene el valor de texto de todos los nodos que son secundarios directos o indirectos del nodo, en el orden en que aparecen en el documento.
isAncestorOf(other)BooleanDetermina si este nodo Element es un superior directo o indirecto de un nodo Element determinado.
isRootElement()BooleanDetermina si el nodo Element es el nodo raíz del documento.
removeAttribute(attribute)BooleanQuita el atributo especificado para este nodo Element, si existe.
removeAttribute(attributeName)BooleanQuita el atributo de este nodo Element con el nombre dado y sin espacio de nombres, si existe tal atributo.
removeAttribute(attributeName, namespace)BooleanQuita el atributo de este nodo Element con el nombre y el espacio de nombres determinados, si existe tal atributo.
removeContent()Content[]Elimina todos los nodos que son secundarios inmediatos del nodo {@code Element}.
removeContent(content)BooleanElimina el nodo especificado si es un elemento secundario inmediato del nodo {@code Element}.
removeContent(index)ContentElimina el nodo en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}.
setAttribute(attribute)ElementConfigura el atributo dado para este nodo Element.
setAttribute(name, value)ElementConfigura el atributo para este nodo Element con el nombre y valor dados, y sin espacio de nombres.
setAttribute(name, value, namespace)ElementConfigura el atributo para este nodo Element con el nombre, el valor y el espacio de nombres determinados.
setName(name)ElementConfigura el nombre local del nodo Element.
setNamespace(namespace)ElementConfigura el espacio de nombres para el nodo Element.
setText(text)ElementEstablece el valor de texto del nodo Element.

Documentación detallada

addContent(content)

Agrega el nodo dado como el último elemento secundario del nodo Element. El argumento content puede ser un objeto Element o cualquier objeto de nodo que corresponda a un tipo enumerado en ContentType.

Parámetros

NombreTipoDescripción
contentContentel nodo que se agregará

Devolvedor

Element: Es el nodo Element para el encadenamiento.


addContent(index, content)

Inserta el nodo determinado en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del nodo Element. El argumento content puede ser un objeto Element o cualquier objeto de nodo que corresponda a un tipo enumerado en ContentType.

Parámetros

NombreTipoDescripción
indexIntegerEl índice en el que se inserta el nodo entre todos los nodos que son elementos secundarios inmediatos del nodo Element.
contentContentel nodo para insertar

Devolvedor

Element: Es el nodo Element para el encadenamiento.


cloneContent()

Crea copias sin adjuntar de todos los nodos que son secundarios inmediatos del nodo {@code Element}.

Devolvedor

Content[]: Es un array de copias sin conectar de todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}.


detach()

Desconecta el nodo de su nodo superior Element. Si el nodo no tiene un superior, este método no tiene efecto.

Devolvedor

Content: Es el nodo desconectado.


getAllContent()

Obtiene todos los nodos que son secundarios inmediatos del nodo {@code Element}.

Devolvedor

Content[]: Es un array de todos los nodos que son secundarios inmediatos del nodo {@code Element}.


getAttribute(name)

Obtiene el atributo para este nodo Element con el nombre dado y sin espacio de nombres. Si no existe tal atributo, este método muestra null.

Parámetros

NombreTipoDescripción
nameStringel nombre del atributo

Devolvedor

Attribute: Es el atributo o null si no hay ningún atributo con el nombre determinado ni espacio de nombres.


getAttribute(name, namespace)

Obtiene el atributo de este nodo Element con el nombre y el espacio de nombres determinados. Si no existe ese nodo, este método muestra null.

Parámetros

NombreTipoDescripción
nameStringel nombre del atributo
namespaceNamespaceel espacio de nombres del atributo

Devolvedor

Attribute: Es el atributo o null si no hay ningún atributo con el nombre y el espacio de nombres dados.


getAttributes()

Obtiene todos los atributos de este nodo Element, en el orden en que aparecen en el documento.

Devolvedor

Attribute[]: Es un array de todos los atributos de este nodo Element.


getChild(name)

Obtiene el primer nodo de Element con el nombre dado y sin espacio de nombres que sea un elemento secundario inmediato de este nodo Element. Si no existe ese nodo, este método muestra null.

Parámetros

NombreTipoDescripción
nameStringel nombre del nodo secundario Element

Devolvedor

Element: Es el nodo Element o null si no hay un nodo secundario Element inmediato con el nombre determinado ni espacio de nombres.


getChild(name, namespace)

Obtiene el primer nodo Element con el nombre y el espacio de nombres dados, que es un elemento secundario inmediato de este nodo Element. Si no existe ese nodo, este método muestra null.

Parámetros

NombreTipoDescripción
nameStringel nombre del nodo secundario Element
namespaceNamespaceel espacio de nombres del nodo Element secundario

Devolvedor

Element: Es el nodo Element o null si no hay un nodo secundario Element inmediato con el nombre y el espacio de nombres dados.


getChildText(name)

Obtiene el valor de texto del nodo con el nombre dado y sin espacio de nombres, si el nodo es un elemento secundario inmediato del nodo Element. Si no existe ese nodo, este método muestra null.

Parámetros

NombreTipoDescripción
nameStringel nombre del nodo secundario

Devolvedor

String: Es el valor de texto del nodo secundario, o null si no hay un nodo secundario inmediato con el nombre dado ni un espacio de nombres.


getChildText(name, namespace)

Obtiene el valor de texto del nodo con el nombre y el espacio de nombres determinados, si el nodo es un elemento secundario inmediato del nodo Element. Si no existe ese nodo, este método muestra null.

Parámetros

NombreTipoDescripción
nameStringel nombre del nodo secundario
namespaceNamespaceel espacio de nombres del nodo secundario

Devolvedor

String: Es el valor de texto del nodo secundario, o null si no hay un nodo secundario inmediato con el nombre y el espacio de nombres dados.


getChildren()

Obtiene todos los nodos Element que son elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.

Devolvedor

Element[]: Es un array de todos los nodos de Element que son elementos secundarios inmediatos de este nodo de Element.


getChildren(name)

Obtiene todos los nodos Element con el nombre dado y ningún espacio de nombres que sean elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.

Parámetros

NombreTipoDescripción
nameStringel nombre de los nodos secundarios Element

Devolvedor

Element[]: Es un array de todos los nodos Element con el nombre dado y sin espacio de nombres que sean elementos secundarios inmediatos de este nodo Element.


getChildren(name, namespace)

Obtiene todos los nodos Element con el nombre y el espacio de nombres determinados que son elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.

Parámetros

NombreTipoDescripción
nameStringel nombre de los nodos secundarios Element
namespaceNamespaceel espacio de nombres de los nodos secundarios Element

Devolvedor

Element[]: Es un array de todos los nodos de Element con el nombre y el espacio de nombres dados, que son elementos secundarios inmediatos de este nodo Element.


getContent(index)

Obtiene el nodo en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}. Si no hay un nodo en el índice dado, este método muestra null.

Parámetros

NombreTipoDescripción
indexIntegerel índice del nodo entre todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}

Devolvedor

Content: Es el nodo o null si no hay ningún nodo en el índice determinado.


getContentSize()

Obtiene la cantidad de nodos que son secundarios inmediatos del nodo {@code Element}.

Devolvedor

Integer: Es el número de nodos que son secundarios inmediatos del nodo {@code Element}.


getDescendants()

Obtiene todos los nodos que son secundarios directos o indirectos del nodo {@code Element}, en el orden en que aparecen en el documento.

Devolvedor

Content[]: Es un array de todos los nodos que son secundarios directos o indirectos del nodo {@code Element}.


getDocument()

Obtiene el documento XML que contiene el nodo {@code Element}.

Devolvedor

Document: Es el documento que contiene el nodo {@code Element}.


getName()

Obtiene el nombre local del nodo Element. Si el nodo tiene un prefijo de espacio de nombres, usa getQualifiedName() o getNamespace().getPrefix() para obtener el prefijo.

Devolvedor

String: Es el nombre local del nodo Element.


getNamespace()

Obtiene el espacio de nombres para el nodo Element.

Devolvedor

Namespace: Es el espacio de nombres del nodo Element.


getNamespace(prefix)

Obtiene el espacio de nombres con el prefijo dado para el nodo Element.

Parámetros

NombreTipoDescripción
prefixStringel prefijo del espacio de nombres

Devolvedor

Namespace: El espacio de nombres con el prefijo dado para el nodo Element


getParentElement()

Obtiene el nodo Element superior del nodo. Si el nodo no tiene un superior, este método muestra null.

Devolvedor

Element: Es el nodo superior Element.


getQualifiedName()

Obtiene el nombre local y el prefijo del espacio de nombres del nodo Element, con el formato [namespacePrefix]:[localName]. Si el nodo no tiene un prefijo de espacio de nombres, usa getName().

Devolvedor

String: Es el nombre local y el prefijo del espacio de nombres del nodo Element, con el formato [namespacePrefix]:[localName].


getText()

Obtiene el valor de texto del nodo Element.

Devolvedor

String: Es el valor de texto del nodo Element.


getValue()

Obtiene el valor de texto de todos los nodos que son secundarios directos o indirectos del nodo, en el orden en que aparecen en el documento.

Devolvedor

String: Es el valor de texto de todos los nodos que son secundarios directos o indirectos del nodo.


isAncestorOf(other)

Determina si este nodo Element es un superior directo o indirecto de un nodo Element determinado.

Parámetros

NombreTipoDescripción
otherElementel otro nodo Element

Devolvedor

Boolean: Es true si este nodo Element es un superior directo o indirecto del nodo Element determinado; false si no es así.


isRootElement()

Determina si el nodo Element es el nodo raíz del documento.

Devolvedor

Boolean: Es true si el nodo Element es el nodo raíz del documento; false si no es así.


removeAttribute(attribute)

Quita el atributo especificado para este nodo Element, si existe.

Parámetros

NombreTipoDescripción
attributeAttributeel atributo

Devolvedor

Boolean: true si el atributo existía y se quitó; false si no es así


removeAttribute(attributeName)

Quita el atributo de este nodo Element con el nombre dado y sin espacio de nombres, si existe tal atributo.

Parámetros

NombreTipoDescripción
attributeNameStringel nombre del atributo

Devolvedor

Boolean: true si el atributo existía y se quitó; false si no es así


removeAttribute(attributeName, namespace)

Quita el atributo de este nodo Element con el nombre y el espacio de nombres determinados, si existe tal atributo.

Parámetros

NombreTipoDescripción
attributeNameStringel nombre del atributo
namespaceNamespaceel espacio de nombres del atributo

Devolvedor

Boolean: true si el atributo existía y se quitó; false si no es así


removeContent()

Elimina todos los nodos que son secundarios inmediatos del nodo {@code Element}.

Devolvedor

Content[]: Es un array de todos los nodos que eran secundarios inmediatos del nodo {@code Element} antes de que se quitaran.


removeContent(content)

Elimina el nodo especificado si es un elemento secundario inmediato del nodo {@code Element}. El argumento content puede ser un objeto Element o cualquier objeto de nodo que corresponda a un tipo enumerado en ContentType.

Parámetros

NombreTipoDescripción
contentContentel nodo para quitar

Devolvedor

Boolean: Es true si el nodo fue un elemento secundario inmediato y se quitó; false si no es así.


removeContent(index)

Elimina el nodo en el índice determinado entre todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}. Si no hay un nodo en el índice dado, este método muestra null.

Parámetros

NombreTipoDescripción
indexIntegerel índice del nodo entre todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}

Devolvedor

Content: Es el nodo que se quitó o null si no hay ningún nodo en el índice determinado.


setAttribute(attribute)

Configura el atributo dado para este nodo Element.

Parámetros

NombreTipoDescripción
attributeAttributeel atributo que se va a definir

Devolvedor

Element: Es el nodo Element para el encadenamiento.


setAttribute(name, value)

Configura el atributo para este nodo Element con el nombre y valor dados, y sin espacio de nombres.

Parámetros

NombreTipoDescripción
nameStringel nombre del atributo que se va a establecer
valueStringel valor del atributo que se va a definir

Devolvedor

Element: Es el nodo Element para el encadenamiento.


setAttribute(name, value, namespace)

Configura el atributo para este nodo Element con el nombre, el valor y el espacio de nombres determinados.

Parámetros

NombreTipoDescripción
nameStringel nombre del atributo que se va a establecer
valueStringel valor del atributo que se va a definir
namespaceNamespaceel espacio de nombres del atributo que se va a definir

Devolvedor

Element: Es el nodo Element para el encadenamiento.


setName(name)

Configura el nombre local del nodo Element. A fin de configurar un prefijo de espacio de nombres para el nodo, usa setNamespace(namespace) junto con XmlService.getNamespace(prefix, uri).

Parámetros

NombreTipoDescripción
nameStringel nombre local para establecer

Devolvedor

Element: Es el nodo Element para el encadenamiento.


setNamespace(namespace)

Configura el espacio de nombres para el nodo Element.

Parámetros

NombreTipoDescripción
namespaceNamespaceespacio de nombres para definir

Devolvedor

Element: Es el nodo Element para el encadenamiento.


setText(text)

Establece el valor de texto del nodo Element. Si el nodo ya contiene un valor de texto o algún nodo secundario, este método reemplaza el contenido anterior. Para agregar o insertar contenido, usa addContent(content) o addContent(index, content).

Parámetros

NombreTipoDescripción
textStringel texto para definir

Devolvedor

Element: Es el nodo Element para el encadenamiento.