Esta página foi traduzida pela API Cloud Translation.

Class NamedRange

Criar, acessar e modificar intervalos nomeados em uma planilha. Os intervalos nomeados são aqueles que aliases de strings associados. Eles podem ser visualizados e editados na interface do Planilhas em Dados > Menu "Intervalos nomeados...".

Métodos

Método	Tipo de retorno	Breve descrição
`getName()`	`String`	Recebe o nome desse intervalo nomeado.
`getRange()`	`Range`	Recebe o intervalo referenciado por este intervalo nomeado.
`remove()`	`void`	Exclui este intervalo nomeado.
`setName(name)`	`NamedRange`	Define/atualiza o nome do intervalo nomeado.
`setRange(range)`	`NamedRange`	Define/atualiza o intervalo para este intervalo nomeado.

Documentação detalhada

`getName()`

Recebe o nome desse intervalo nomeado.

Retornar

String: o nome desse intervalo nomeado.

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/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getRange()`

Recebe o intervalo referenciado por este intervalo nomeado.

Retornar

Range: o intervalo da planilha associado a esse intervalo nomeado.

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/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`remove()`

Exclui este intervalo nomeado.

// The code below deletes all the named ranges in the spreadsheet.
var namedRanges = SpreadsheetApp.getActive().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  namedRanges[i].remove();
}

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/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`setName(name)`

Define/atualiza o nome do intervalo nomeado.

// The code below updates the name for the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
if (namedRanges.length > 1) {
  namedRanges[0].setName("UpdatedNamedRange");
}

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O novo nome do intervalo nomeado.

Retornar

NamedRange: o intervalo cujo nome foi definido pela chamada.

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/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`setRange(range)`

Define/atualiza o intervalo para este intervalo nomeado.

Parâmetros

Nome	Tipo	Descrição
`range`	`Range`	O intervalo da planilha a ser associado a esse intervalo nomeado.

Retornar

NamedRange: o intervalo nomeado para o qual o intervalo da planilha foi definido.

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/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets