Class NamedRange

NamedRange

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 um NamedRange é adicionado a uma guia, ele não pode ser modificado, apenas removido.

Um NamedRange pode ser acessado por qualquer script que acesse a guia. Para evitar conflitos não intencionais entre scripts, prefixe 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étodo	Tipo de retorno	Breve descrição
getId()	String	Recebe o ID desta NamedRange.
getName()	String	Recebe o nome deste NamedRange.
getRange()	Range	Recebe o intervalo de elementos associados a este NamedRange.
remove()	void	Remove este NamedRange da guia.

Documentação detalhada

getId()

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

Retornar

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

---

getName()

Recebe o nome deste NamedRange. O nome não precisa ser exclusivo.

Retornar

String: o nome do intervalo, que não precisa ser 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 este 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 este NamedRange da guia. 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