Class NamedRange

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Nomedointervalo

Criar, acessar e modificar intervalos nomeados em uma planilha. Os intervalos nomeados são intervalos que têm aliases de string associados. Eles podem ser visualizados e editados na IU do Planilhas no menu Dados e intervalos nomeados....

Métodos

MétodoTipo de retornoBreve descrição
getName()StringAcessa o nome desse intervalo nomeado.
getRange()RangeRecebe o intervalo referenciado por este intervalo nomeado.
remove()voidExclui este intervalo nomeado.
setName(name)NamedRangeDefine/atualiza o nome do intervalo nomeado.
setRange(range)NamedRangeDefine/atualiza o intervalo deste intervalo nomeado.

Documentação detalhada

getName()

Acessa o nome desse intervalo nomeado.

Retornar

String: o nome deste intervalo nomeado

Autorização

Os scripts que usam esse método exigem 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 exigem 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 exigem 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

NomeTipoDescrição
nameStringO novo nome do intervalo nomeado.

Retornar

NamedRange: o intervalo cujo nome foi definido pela chamada

Autorização

Os scripts que usam esse método exigem 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 deste intervalo nomeado.

Parâmetros

NomeTipoDescrição
rangeRangeO intervalo da planilha a ser associado a este intervalo nomeado.

Retornar

NamedRange: o intervalo nomeado em que o intervalo da planilha foi definido

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets