Um Range que tem um nome e um ID para permitir a recuperação posterior. Os nomes não são
necessariamente único. vários intervalos diferentes na mesma guia podem ter o mesmo nome, como um
em HTML. Em contrapartida, os IDs são exclusivos na guia, como um ID em HTML. Depois que um NamedRange é adicionado a uma guia, ele não pode ser modificado, apenas removido.
Uma NamedRange pode ser acessada por qualquer script que acesse a guia. Para evitar problemas
conflitos entre scripts, considere prefixar nomes de intervalos com uma string exclusiva.
// Create a named range that includes every table in the active tab.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
getId() | String | Recebe o ID desse NamedRange. |
getName() | String | Recebe o nome desse NamedRange. |
getRange() | Range | Recebe o intervalo de elementos associados a esse NamedRange. |
remove() | void | Remove este NamedRange da guia. |
Documentação detalhada
getId()
Recebe o ID desse NamedRange. O ID é exclusivo na guia.
Retornar
String: o ID do intervalo, que é exclusivo na guia.
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 precisam de 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 de elementos associados a esse NamedRange.
Retornar
Range: o intervalo de elementos associados ao nome e ao ID.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove()
Remove este NamedRange da guia. Esse método não exclui o conteúdo do
intervalo; ela apenas remove a referência. Chamar esse método em um NamedRange que
já foi removido não tem efeito.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents