Um Range que tem um nome e um ID para permitir a recuperação posterior. Os nomes não são necessariamente exclusivos. Diversos intervalos diferentes no mesmo documento podem compartilhar o mesmo nome, assim como uma classe em HTML. Por outro lado, os IDs são exclusivos dentro do documento, como um ID em HTML. Depois que um
NamedRange é adicionado a um documento, ele não pode ser modificado, apenas removido.
Um NamedRange pode ser acessado por qualquer script que acesse o documento. Para evitar conflitos não intencionais entre scripts, considere prefixar nomes de intervalos com uma string exclusiva.
// 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é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 do documento. |
Documentação detalhada
getId()
Recebe o ID desse NamedRange. O ID é exclusivo no documento.
Retorno
String: o ID do intervalo, exclusivo no documento
getName()
Recebe o nome desse NamedRange. O nome não é necessariamente exclusivo.
Retorno
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 de elementos associados a esse NamedRange.
Retorno
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 este 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á foi 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