Class NamedRange

Intervalonomeado

Um 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 na mesma guia podem compartilhar o mesmo nome, assim como uma classe em HTML. Por outro lado, os IDs são exclusivos na guia, como um ID em HTML. Depois que uma NamedRange é adicionada a uma guia, ela não pode ser modificada, apenas removida.

Uma NamedRange pode ser acessada por qualquer script que acesse a guia. Para evitar conflitos inesperados entre scripts, considere prefixar os nomes de intervalos com uma string exclusiva. 

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

Métodos

MétodoTipo de retornoBreve descrição
getId()StringRecebe o ID dessa NamedRange.
getName()StringExtrai o nome deste NamedRange.
getRange()RangeConsegue o intervalo de elementos associados a essa NamedRange.
remove()voidRemove NamedRange da guia.

Documentação detalhada

getId()

Recebe o ID dessa NamedRange. O ID é exclusivo na guia.

Retornar

String: o ID do intervalo, que é exclusivo na guia.

getName()

Extrai o nome deste 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()

Consegue o intervalo de 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 NamedRange da guia. Esse método não exclui o conteúdo do intervalo, apenas remove a referência. Chamar esse método em uma NamedRange que já foi removida 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