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

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 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 Element superior.
getAllContent()Content[]Obtiene todos los nodos que son secundarios inmediatos del nodo {@code Element}.
getAttribute(name)AttributeObtiene el atributo de este nodo Element con el nombre determinado 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 Element con el nombre determinado 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 determinados que es un elemento secundario inmediato 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 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 determinado y sin 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 elementos 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 del nodo Element.
getNamespace(prefix)NamespaceObtiene el espacio de nombres con el prefijo determinado 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, 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 en el documento.
isAncestorOf(other)BooleanDetermina si este nodo 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 determinado para este nodo Element, si existe.
removeAttribute(attributeName)BooleanQuita el atributo de este nodo Element con el nombre determinado y sin espacio de nombres, si existe un atributo de este tipo.
removeAttribute(attributeName, namespace)BooleanQuita el atributo de este nodo Element con el nombre y el espacio de nombres determinados, si existe un atributo de este tipo.
removeContent()Content[]Quita todos los nodos que sean secundarios inmediatos del nodo {@code Element}.
removeContent(content)BooleanQuita el nodo determinado, si es un elemento secundario inmediato del nodo {@code Element}.
removeContent(index)ContentQuita el nodo en el índice determinado entre todos los nodos que son secundarios inmediatos del nodo {@code Element}.
setAttribute(attribute)ElementEstablece el atributo determinado para este nodo Element.
setAttribute(name, value)ElementEstablece el atributo para este nodo Element con el nombre y el valor determinados, y sin espacio de nombres.
setAttribute(name, value, namespace)ElementEstablece el atributo para este nodo Element con el nombre, el valor y el espacio de nombres determinados.
setName(name)ElementEstablece el nombre local del nodo Element.
setNamespace(namespace)ElementEstablece 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 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á

Volver

Element: Es el nodo Element para encadenar.

addContent(index, content)

Inserta el nodo determinado en el índice determinado entre todos los nodos que son secundarios inmediatos del nodo Element. El argumento content puede ser un objeto Element o cualquier objeto de nodo que corresponda a un tipo que se muestra 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 que se insertará

Volver

Element: Es el nodo Element para encadenar.

cloneContent()

Crea copias sin adjuntar 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 secundarios inmediatos del nodo Content[].

detach()

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

Volver

Content: 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 de este nodo Element con el nombre determinado y sin espacio de nombres. Si no hay tal atributo, este método muestra null.

Parámetros

NombreTipoDescripción
nameStringel nombre del atributo

Volver

Attribute: Es el atributo, o null si no hay un atributo con el nombre determinado y no hay espacio de nombres.

getAttribute(name, namespace)

Obtiene el atributo de este nodo Element con el nombre y el espacio de nombres determinados. Si no hay un nodo de este tipo, 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 un 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.

Volver

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

getChild(name)

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

Parámetros

NombreTipoDescripción
nameStringel nombre del nodo Element secundario

Volver

Element: El nodo Element o null si no hay un nodo Element secundario inmediato con el nombre determinado y sin espacio de nombres

getChild(name, namespace)

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

Parámetros

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

Volver

Element: El nodo Element o null si no hay un nodo Element secundario inmediato con el nombre y el espacio de nombres determinados

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 hay tal nodo, este método muestra 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 determinado y sin 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 hay un nodo de este tipo, 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 el espacio de nombres determinados.

getChildren()

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

Volver

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

getChildren(name)

Obtiene todos los nodos Element con el nombre determinado y sin 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 Element secundarios

Volver

Element[]: Es un array de todos los nodos Element con el nombre determinado y sin espacio de nombres que son 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 Element secundarios
namespaceNamespaceel espacio de nombres de los nodos Element secundarios

Volver

Element[]: Es un array de todos los nodos Element con el nombre y el espacio de nombres determinados 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 ningún nodo 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 del nodo {@code Element}

Volver

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

Volver

Integer: Es la cantidad de nodos que son hijos inmediatos del nodo {@code Element}.

getDescendants()

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

Volver

Content[]: Es un array de todos los nodos que son elementos 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() para obtener el prefijo.

Volver

String: Es el nombre local del nodo Element.

getNamespace()

Obtiene el espacio de nombres del nodo Element.

Volver

Namespace: Es el espacio de nombres del nodo Element.

getNamespace(prefix)

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

Parámetros

NombreTipoDescripción
prefixStringel prefijo del espacio de nombres

Volver

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

getParentElement()

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

Volver

Element: Es el nodo Element superior.

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

Volver

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

isAncestorOf(other)

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

Parámetros

NombreTipoDescripción
otherElementel otro nodo Element

Volver

Boolean: Es true si este nodo Element es un elemento 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.

Volver

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

removeAttribute(attribute)

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

Parámetros

NombreTipoDescripción
attributeAttributeel atributo

Volver

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

removeAttribute(attributeName)

Quita el atributo de este nodo Element con el nombre determinado y sin espacio de nombres, si existe un atributo de este tipo.

Parámetros

NombreTipoDescripción
attributeNameStringel nombre del atributo

Volver

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

removeAttribute(attributeName, namespace)

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

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

removeContent()

Quita todos los nodos que sean 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 quitaran.

removeContent(content)

Quita el nodo determinado, 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 que se quitará

Volver

Boolean: true si el nodo era un elemento secundario inmediato y se quitó; false si no

removeContent(index)

Quita el nodo en el índice determinado entre todos los nodos que son secundarios inmediatos del nodo {@code Element}. Si no hay ningún nodo 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 del nodo {@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 determinado para este nodo Element.

Parámetros

NombreTipoDescripción
attributeAttributeel atributo que se establecerá

Volver

Element: Es el nodo Element para encadenar.

setAttribute(name, value)

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

Parámetros

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

Volver

Element: Es el nodo Element para encadenar.

setAttribute(name, value, namespace)

Establece 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 debe establecer
valueStringel valor del atributo que se establecerá
namespaceNamespaceel espacio de nombres del atributo que se establecerá

Volver

Element: Es el nodo Element para encadenar.

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 que se establecerá

Volver

Element: Es el nodo Element para encadenar.

setNamespace(namespace)

Establece el espacio de nombres para el nodo Element.

Parámetros

NombreTipoDescripción
namespaceNamespaceel espacio de nombres que se establecerá

Volver

Element: Es el nodo Element para encadenar.

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. En su lugar, usa addContent(content) o addContent(index, content) para agregar o insertar contenido.

Parámetros

NombreTipoDescripción
textStringel texto que se establecerá

Volver

Element: Es el nodo Element para encadenar.