Class Element

Elemento

Uma representação de um nó 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);

Métodos

MétodoTipo de retornoBreve descrição
addContent(content)ElementAnexa o nó especificado como o último filho do nó Element.
addContent(index, content)ElementInsere o nó especificado no índice especificado entre todos os nós que são filhos imediatos do nó Element.
cloneContent()Content[]Cria cópias não anexadas de todos os nós que são filhos imediatos do nó {@code Element}.
detach()ContentRemove o nó do nó Element pai.
getAllContent()Content[]Extrai todos os nós que são filhos imediatos do nó {@code Element}.
getAttribute(name)AttributeRecebe o atributo deste nó Element com o nome fornecido e sem namespace.
getAttribute(name, namespace)AttributeRecebe o atributo desse nó Element com o nome e o namespace fornecidos.
getAttributes()Attribute[]Recebe todos os atributos deste nó Element, na ordem em que aparecem no documento.
getChild(name)ElementRecebe o primeiro nó Element com o nome fornecido e nenhum namespace que seja filho imediato desse nó Element.
getChild(name, namespace)ElementRecebe o primeiro nó Element com o nome e o namespace fornecidos, que é filho imediato desse nó Element.
getChildText(name)StringRecebe o valor de texto do nó com o nome especificado e nenhum namespace, se o nó for um filho imediato do Element.
getChildText(name, namespace)StringRecebe o valor de texto do nó com o nome e o namespace fornecidos, se o nó for um filho imediato do Element.
getChildren()Element[]Recebe todos os nós Element que são filhos imediatos desse nó Element, na ordem em que aparecem no documento.
getChildren(name)Element[]Recebe todos os nós Element com o nome indicado e nenhum namespace que sejam filhos imediatos desse nó Element, na ordem em que aparecem no documento.
getChildren(name, namespace)Element[]Recebe todos os nós Element com o nome e namespace fornecidos que são filhos imediatos desse nó Element, na ordem em que aparecem no documento.
getContent(index)ContentRecebe o nó no índice especificado entre todos os nós que são filhos imediatos do nó {@code Element}.
getContentSize()IntegerExtrai o número de nós que são filhos imediatos do nó {@code Element}.
getDescendants()Content[]Extrai todos os nós que são filhos diretos ou indiretos do nó {@code Element}, na ordem em que aparecem no documento.
getDocument()DocumentAcessa o documento XML que contém o nó {@code Element}.
getName()StringRecebe o nome local do nó Element.
getNamespace()NamespaceRecebe o namespace do nó Element.
getNamespace(prefix)NamespaceRecebe o namespace com o prefixo fornecido para o nó Element.
getParentElement()ElementRecebe o nó Element pai.
getQualifiedName()StringRecebe o nome local e o prefixo do namespace do nó Element, no formato [namespacePrefix]:[localName].
getText()StringRecebe o valor de texto do nó Element.
getValue()StringRecebe o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento.
isAncestorOf(other)BooleanDetermina se esse nó Element é um pai direto ou indireto de um determinado nó Element.
isRootElement()BooleanDetermina se o nó Element é o nó raiz do documento.
removeAttribute(attribute)BooleanRemove o atributo fornecido para o nó Element, se houver um.
removeAttribute(attributeName)BooleanRemove o atributo do nó Element com o nome fornecido e sem namespace, se esse atributo existir.
removeAttribute(attributeName, namespace)BooleanRemove o atributo do nó Element com o nome e o namespace fornecidos, se um atributo existir.
removeContent()Content[]Remove todos os nós que são filhos imediatos do nó {@code Element}.
removeContent(content)BooleanRemove o nó especificado, se o nó for um filho imediato do nó {@code Element}.
removeContent(index)ContentRemove o nó no índice especificado entre todos os nós que são filhos imediatos do nó {@code Element}.
setAttribute(attribute)ElementDefine o atributo fornecido para este nó Element.
setAttribute(name, value)ElementDefine o atributo deste nó Element com o nome e o valor fornecidos e nenhum namespace.
setAttribute(name, value, namespace)ElementDefine o atributo deste nó Element com o nome, o valor e o namespace fornecidos.
setName(name)ElementDefine o nome local do nó Element.
setNamespace(namespace)ElementDefine o namespace do nó Element.
setText(text)ElementDefine o valor de texto do nó Element.

Documentação detalhada

addContent(content)

Anexa o nó especificado como o último filho do nó Element. O argumento content pode ser um objeto Element ou qualquer objeto de nó que corresponda a um tipo listado em ContentType.

Parâmetros

NomeTipoDescrição
contentContento nó a ser anexado

Retorno

Element: o nó Element, para encadeamento


addContent(index, content)

Insere o nó especificado no índice especificado entre todos os nós que são filhos imediatos do nó Element. O argumento content pode ser um objeto Element ou qualquer objeto de nó que corresponda a um tipo listado em ContentType.

Parâmetros

NomeTipoDescrição
indexIntegero índice em que inserir o nó entre todos os nós que são filhos imediatos do nó Element
contentContento nó a ser inserido

Retorno

Element: o nó Element, para encadeamento


cloneContent()

Cria cópias não anexadas de todos os nós que são filhos imediatos do nó {@code Element}.

Retorno

Content[]: uma matriz de cópias não anexadas de todos os nós que são filhos imediatos do nó {@code Element}


detach()

Remove o nó do nó Element pai. Se o nó não tiver um pai, este método não terá efeito.

Retorno

Content: o nó desconectado


getAllContent()

Extrai todos os nós que são filhos imediatos do nó {@code Element}.

Retorno

Content[]: uma matriz de todos os nós que são filhos imediatos do nó {@code Element}


getAttribute(name)

Recebe o atributo deste nó Element com o nome fornecido e sem namespace. Se não houver esse atributo, esse método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do atributo

Retorno

Attribute: o atributo ou null se não houver um atributo com o nome fornecido e nenhum namespace


getAttribute(name, namespace)

Recebe o atributo desse nó Element com o nome e o namespace fornecidos. Se não houver esse nó, esse método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do atributo
namespaceNamespaceo namespace do atributo

Retorno

Attribute: o atributo ou null se não houver um atributo com o nome e o namespace fornecidos


getAttributes()

Recebe todos os atributos deste nó Element, na ordem em que aparecem no documento.

Retorno

Attribute[]: uma matriz de todos os atributos do nó Element.


getChild(name)

Recebe o primeiro nó Element com o nome fornecido e nenhum namespace que seja filho imediato desse nó Element. Se não houver esse nó, o método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do nó Element filho

Retorno

Element: o nó Element ou null se não houver um nó Element filho imediato com o nome fornecido e nenhum namespace


getChild(name, namespace)

Recebe o primeiro nó Element com o nome e o namespace fornecidos, que é filho imediato desse nó Element. Se não houver esse nó, o método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do nó Element filho
namespaceNamespaceo namespace do nó Element filho

Retorno

Element: o nó Element ou null se não houver um nó Element filho imediato com o nome e o namespace fornecidos


getChildText(name)

Recebe o valor de texto do nó com o nome especificado e nenhum namespace, se o nó for um filho imediato do Element. Se não houver esse nó, esse método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do nó filho

Retorno

String: o valor do texto do nó filho ou null se não houver um nó filho imediato com o nome indicado e nenhum namespace


getChildText(name, namespace)

Recebe o valor de texto do nó com o nome e o namespace fornecidos, se o nó for um filho imediato do Element. Se não houver esse nó, o método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do nó filho
namespaceNamespaceo namespace do nó filho

Retorno

String: o valor do texto do nó filho ou null se não houver um nó filho imediato com o nome e o namespace fornecidos


getChildren()

Recebe todos os nós Element que são filhos imediatos desse nó Element, na ordem em que aparecem no documento.

Retorno

Element[]: uma matriz de todos os nós Element que são filhos imediatos desse nó Element


getChildren(name)

Recebe todos os nós Element com o nome indicado e nenhum namespace que sejam filhos imediatos desse nó Element, na ordem em que aparecem no documento.

Parâmetros

NomeTipoDescrição
nameStringo nome dos nós Element filhos

Retorno

Element[]: uma matriz de todos os nós Element com o nome especificado e nenhum namespace que seja filho imediato desse nó Element


getChildren(name, namespace)

Recebe todos os nós Element com o nome e namespace fornecidos que são filhos imediatos desse nó Element, na ordem em que aparecem no documento.

Parâmetros

NomeTipoDescrição
nameStringo nome dos nós Element filhos
namespaceNamespaceo namespace dos nós Element filhos

Retorno

Element[]: uma matriz de todos os nós Element com o nome e namespace fornecidos que são filhos imediatos desse nó Element


getContent(index)

Recebe o nó no índice especificado entre todos os nós que são filhos imediatos do nó {@code Element}. Se não houver nenhum nó no índice especificado, esse método retornará null.

Parâmetros

NomeTipoDescrição
indexIntegero índice do nó entre todos os nós que são filhos imediatos do nó {@code Element}

Retorno

Content: o nó ou null se não houver nó no índice especificado


getContentSize()

Extrai o número de nós que são filhos imediatos do nó {@code Element}.

Retorno

Integer: o número de nós que são filhos imediatos do nó {@code Element}


getDescendants()

Extrai todos os nós que são filhos diretos ou indiretos do nó {@code Element}, na ordem em que aparecem no documento.

Retorno

Content[]: uma matriz de todos os nós que são filhos diretos ou indiretos do nó {@code Element}


getDocument()

Acessa o documento XML que contém o nó {@code Element}.

Retorno

Document: o documento que contém o nó {@code Element}


getName()

Recebe o nome local do nó Element. Se o nó tiver um prefixo de namespace, use getQualifiedName() ou getNamespace().getPrefix() para receber o prefixo.

Retorno

String: o nome local do nó Element


getNamespace()

Recebe o namespace do nó Element.

Retorno

Namespace: o namespace do nó Element


getNamespace(prefix)

Recebe o namespace com o prefixo fornecido para o nó Element.

Parâmetros

NomeTipoDescrição
prefixStringo prefixo do namespace

Retorno

Namespace: o namespace com o prefixo especificado para o nó Element


getParentElement()

Recebe o nó Element pai. Se o nó não tiver um pai, esse método retornará null.

Retorno

Element: o nó pai Element


getQualifiedName()

Recebe o nome local e o prefixo do namespace do nó Element, no formato [namespacePrefix]:[localName]. Se o nó não tiver um prefixo de namespace, use getName().

Retorno

String: o nome local e o prefixo do namespace do nó Element, no formato [namespacePrefix]:[localName]


getText()

Recebe o valor de texto do nó Element.

Retorno

String: o valor de texto do nó Element


getValue()

Recebe o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento.

Retorno

String: o valor de texto de todos os nós que são filhos diretos ou indiretos do nó


isAncestorOf(other)

Determina se esse nó Element é um pai direto ou indireto de um determinado nó Element.

Parâmetros

NomeTipoDescrição
otherElemento outro nó Element

Retorno

Boolean: true se esse nó Element for um pai direto ou indireto do nó Element especificado; false se não for


isRootElement()

Determina se o nó Element é o nó raiz do documento.

Retorno

Boolean: true se o nó Element for o nó raiz do documento; se não for o caso, false


removeAttribute(attribute)

Remove o atributo fornecido para o nó Element, se houver um.

Parâmetros

NomeTipoDescrição
attributeAttributeo atributo

Retorno

Boolean: true se o atributo existia e foi removido; false se não existir


removeAttribute(attributeName)

Remove o atributo do nó Element com o nome fornecido e sem namespace, se esse atributo existir.

Parâmetros

NomeTipoDescrição
attributeNameStringo nome do atributo

Retorno

Boolean: true se o atributo existia e foi removido; false se não existir


removeAttribute(attributeName, namespace)

Remove o atributo do nó Element com o nome e o namespace fornecidos, se um atributo existir.

Parâmetros

NomeTipoDescrição
attributeNameStringo nome do atributo
namespaceNamespaceo namespace do atributo

Retorno

Boolean: true se o atributo existia e foi removido; false se não existir


removeContent()

Remove todos os nós que são filhos imediatos do nó {@code Element}.

Retorno

Content[]: uma matriz de todos os nós que eram filhos imediatos do nó {@code Element} antes de serem removidos


removeContent(content)

Remove o nó especificado, se o nó for um filho imediato do nó {@code Element}. O argumento content pode ser um objeto Element ou qualquer objeto de nó que corresponda a um tipo listado em ContentType.

Parâmetros

NomeTipoDescrição
contentContento nó a ser removido

Retorno

Boolean: true se o nó era um filho imediato e foi removido; false se não for


removeContent(index)

Remove o nó no índice especificado entre todos os nós que são filhos imediatos do nó {@code Element}. Se não houver nenhum nó no índice especificado, esse método retornará null.

Parâmetros

NomeTipoDescrição
indexIntegero índice do nó entre todos os nós que são filhos imediatos do nó {@code Element}

Retorno

Content: o nó que foi removido ou null se não houver nó no índice especificado


setAttribute(attribute)

Define o atributo fornecido para este nó Element.

Parâmetros

NomeTipoDescrição
attributeAttributeo atributo a ser definido

Retorno

Element: o nó Element, para encadeamento


setAttribute(name, value)

Define o atributo deste nó Element com o nome e o valor fornecidos e nenhum namespace.

Parâmetros

NomeTipoDescrição
nameStringo nome do atributo a ser definido
valueStringo valor do atributo a ser definido

Retorno

Element: o nó Element, para encadeamento


setAttribute(name, value, namespace)

Define o atributo deste nó Element com o nome, o valor e o namespace fornecidos.

Parâmetros

NomeTipoDescrição
nameStringo nome do atributo a ser definido
valueStringo valor do atributo a ser definido
namespaceNamespaceo namespace do atributo a ser definido

Retorno

Element: o nó Element, para encadeamento


setName(name)

Define o nome local do nó Element. Para definir um prefixo de namespace para o nó, use setNamespace(namespace) com XmlService.getNamespace(prefix, uri).

Parâmetros

NomeTipoDescrição
nameStringo nome local a ser definido

Retorno

Element: o nó Element, para encadeamento


setNamespace(namespace)

Define o namespace do nó Element.

Parâmetros

NomeTipoDescrição
namespaceNamespaceo namespace a ser definido

Retorno

Element: o nó Element, para encadeamento


setText(text)

Define o valor de texto do nó Element. Se o nó já contiver um valor de texto ou qualquer nó filho, esse método vai substituir o conteúdo antigo. Para anexar ou inserir conteúdo, use addContent(content) ou addContent(index, content).

Parâmetros

NomeTipoDescrição
textStringo texto a ser definido

Retorno

Element: o nó Element, para encadeamento