Class NamedRange

Nomedointervalo

Uma Range que tem um nome e um ID para permitir a recuperação posterior. Os nomes não são necessariamente exclusivos. Vários intervalos diferentes no mesmo documento podem compartilhar o mesmo nome, muito parecido com uma classe em HTML. Por outro lado, os IDs são exclusivos no documento, como um ID em HTML. Depois que um NamedRange for adicionado a um documento, ele não poderá ser modificado, apenas removido.

Uma NamedRange pode ser acessada por qualquer script que acesse o documento. Para evitar conflitos não intencionais entre scripts, use um string exclusivo antes do nome dos intervalos. 

// Create a named range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());

Métodos

MétodoTipo de retornoBreve descrição
getId()StringRecebe o ID deste NamedRange.
getName()StringRecebe o nome desse NamedRange.
getRange()RangeRecebe o intervalo dos elementos associados a essa NamedRange.
remove()voidRemove esse NamedRange do documento.

Documentação detalhada

getId()

Recebe o ID deste NamedRange. O ID é exclusivo no documento.

Retornar

String: o ID do intervalo, que é exclusivo no documento

getName()

Recebe o nome desse NamedRange. O nome não é necessariamente exclusivo.

Retornar

String: o nome do intervalo, que não é necessariamente exclusivo

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getRange()

Recebe o intervalo dos elementos associados a essa NamedRange.

Retornar

Range: o intervalo de elementos associados ao nome e ao ID

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

remove()

Remove esse NamedRange do documento. Esse método não exclui o conteúdo do intervalo, apenas remove a referência. Chamar esse método em um NamedRange que já tenha sido removido não tem efeito.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents