Class Element

Elemento

Es una 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 determinado 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 secundarios inmediatos de la Nodo Element.
cloneContent()Content[]Crea copias no adjuntas 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 especificados.
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 determinado y sin espacio de nombres que sea un elemento inmediato elemento secundario de este nodo Element.
getChild(name, namespace)ElementObtiene el primer nodo de Element con el nombre y el espacio de nombres especificados que es un elemento elemento secundario de este nodo Element.
getChildText(name)StringObtiene el valor de texto del nodo con el nombre determinado 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 especificados si el nodo es un elemento elemento secundario del nodo Element
getChildren()Element[]Obtiene todos los nodos Element que son secundarios inmediatos de este nodo Element, en el orden en el que aparecen en el documento.
getChildren(name)Element[]Obtiene todos los nodos de Element con el nombre determinado y ningún espacio de nombres que sean secundarios inmediatos. de este nodo Element, en el orden en que aparecen en el documento.
getChildren(name, namespace)Element[]Obtiene todos los nodos de Element con el nombre y el espacio de nombres especificados que son secundarios inmediatos de este nodo de 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 secundarios inmediatos de la {@code Element}.
getContentSize()IntegerObtiene el número 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 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 especificado para el nodo Element.
getParentElement()ElementObtiene el nodo superior Element del nodo.
getQualifiedName()StringObtiene el nombre local y el prefijo del espacio de nombres del nodo Element, en 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. aparecen en el documento.
isAncestorOf(other)BooleanDetermina si este nodo de Element es un elemento 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 uno.
removeAttribute(attributeName)BooleanQuita el atributo de este nodo Element con el nombre dado y sin espacio de nombres, si existe ese atributo.
removeAttribute(attributeName, namespace)BooleanQuita el atributo de este nodo Element con el nombre y el espacio de nombres especificados, de ser así. existe un atributo.
removeContent()Content[]Elimina todos los nodos que son secundarios inmediatos del nodo {@code Element}.
removeContent(content)BooleanElimina un nodo determinado si el nodo es un elemento secundario inmediato del nodo {@code Element}.
removeContent(index)ContentElimina el nodo en el índice determinado entre todos los nodos que son secundarios inmediatos de la {@code Element}.
setAttribute(attribute)ElementEstablece el atributo proporcionado para este nodo Element.
setAttribute(name, value)ElementEstablece el atributo de este nodo Element con el nombre y el valor especificados, y sin espacio de nombres.
setAttribute(name, value, namespace)ElementEstablece el atributo de este nodo Element con el nombre, el valor y el espacio de nombres especificados.
setName(name)ElementEstablece 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 determinado como el último elemento secundario del nodo Element. El content El argumento puede ser un objeto Element o cualquier objeto de nodo que corresponda a un tipo que figuran en ContentType.

Parámetros

NombreTipoDescripción
contentContentel nodo para adjuntar

Volver

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 secundarios inmediatos de la Nodo Element. El argumento content puede ser un objeto Element o cualquier objeto de nodo que corresponde 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 secundarios inmediatos del nodo Element
contentContentel nodo para insertar

Volver

Element: Es el nodo Element para el encadenamiento.


cloneContent()

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

Volver

Content[]: Es un array de copias no adjuntas de todos los nodos que son elementos secundarios inmediatos de la Nodo de {@code Element}


detach()

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

Volver

Content: Es el nodo desconectado.


getAllContent()

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

Volver

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 ese atributo, este método muestra null.

Parámetros

NombreTipoDescripción
nameStringel nombre del atributo

Volver

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


getAttribute(name, namespace)

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

Parámetros

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

Volver

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


getAttributes()

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

Volver

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


getChild(name)

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

Parámetros

NombreTipoDescripción
nameStringel nombre del nodo secundario Element

Volver

Element: Es el nodo Element, o null si no hay un nodo secundario Element inmediato con el nombre dado y ningún espacio de nombres.


getChild(name, namespace)

Obtiene el primer nodo de Element con el nombre y el espacio de nombres especificados que es un elemento elemento secundario 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 secundario Element

Volver

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


getChildText(name)

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

Parámetros

NombreTipoDescripción
nameStringel nombre del nodo secundario

Volver

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


getChildText(name, namespace)

Obtiene el valor de texto del nodo con el nombre y el espacio de nombres especificados si el nodo es un elemento elemento secundario 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

Volver

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


getChildren()

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

Volver

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


getChildren(name)

Obtiene todos los nodos de Element con el nombre determinado y ningún espacio de nombres que sean 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

Volver

Element[]: Es un array de todos los nodos Element con el nombre determinado y ningún espacio de nombres que se haya elementos secundarios inmediatos de este nodo Element


getChildren(name, namespace)

Obtiene todos los nodos de Element con el nombre y el espacio de nombres especificados que son secundarios inmediatos de este nodo de 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

Volver

Element[]: Es un array de todos los nodos Element con el nombre y el espacio de nombres determinados que se elementos secundarios inmediatos de este nodo Element


getContent(index)

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

Parámetros

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

Volver

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


getContentSize()

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

Volver

Integer: Es la cantidad 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 en el documento.

Volver

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

Volver

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() a para obtener el prefijo.

Volver

String: Es el nombre local del nodo Element.


getNamespace()

Obtiene el espacio de nombres para el nodo Element.

Volver

Namespace: Es el espacio de nombres del nodo Element.


getNamespace(prefix)

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

Parámetros

NombreTipoDescripción
prefixStringel prefijo del espacio de nombres

Volver

Namespace: Es el espacio de nombres con el prefijo especificado para el nodo Element.


getParentElement()

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

Volver

Element: Es el nodo superior Element.


getQualifiedName()

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

Volver

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


getText()

Obtiene el valor de texto del nodo Element.

Volver

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. aparecen en el documento.

Volver

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


isAncestorOf(other)

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

Parámetros

NombreTipoDescripción
otherElementel otro nodo Element

Volver

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


isRootElement()

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

Volver

Boolean: true si el nodo Element es el nodo raíz del documento false si no


removeAttribute(attribute)

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

Parámetros

NombreTipoDescripción
attributeAttributeel atributo

Volver

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

Parámetros

NombreTipoDescripción
attributeNameStringel nombre del atributo

Volver

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 especificados, de ser así. existe un atributo.

Parámetros

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

Volver

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

Volver

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


removeContent(content)

Elimina un nodo determinado si el nodo 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 indicado en ContentType.

Parámetros

NombreTipoDescripción
contentContentel nodo para quitar

Volver

Boolean: true si el nodo era 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 secundarios inmediatos de la {@code Element}. Si no hay nodos en el índice determinado, este método muestra null.

Parámetros

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

Volver

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


setAttribute(attribute)

Establece el atributo proporcionado para este nodo Element.

Parámetros

NombreTipoDescripción
attributeAttributeel atributo que se establecerá

Volver

Element: Es el nodo Element para el encadenamiento.


setAttribute(name, value)

Establece el atributo de este nodo Element con el nombre y el valor especificados, y sin espacio de nombres.

Parámetros

NombreTipoDescripción
nameStringel nombre del atributo que se configurará
valueStringel valor del atributo que se configurará

Volver

Element: Es el nodo Element para el encadenamiento.


setAttribute(name, value, namespace)

Establece el atributo de este nodo Element con el nombre, el valor y el espacio de nombres especificados.

Parámetros

NombreTipoDescripción
nameStringel nombre del atributo que se configurará
valueStringel valor del atributo que se configurará
namespaceNamespaceel espacio de nombres del atributo que se configurará

Volver

Element: Es el nodo Element para el encadenamiento.


setName(name)

Establece el nombre local del nodo Element. Para establecer 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

Volver

Element: Es el nodo Element para el encadenamiento.


setNamespace(namespace)

Configura el espacio de nombres para el nodo Element.

Parámetros

NombreTipoDescripción
namespaceNamespaceel espacio de nombres para configurar

Volver

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 cualquier 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 establecer

Volver

Element: Es el nodo Element para el encadenamiento.