ExcelScript.Range interface

Range representa um conjunto de uma ou mais células contíguas, como uma célula, uma linha, uma coluna, um bloco de células, etc.

Métodos

addConditionalFormat(type)

Adiciona um novo formato condicional à coleção na prioridade First/Top.

autoFill(destinationRange, autoFillType)

Preenche o intervalo do intervalo atual com o intervalo de destino especificado usando a lógica de preenchimento automático especificada. O intervalo de destino pode ser nulo, ou pode estender a fonte horizontal ou verticalmente. Não há suporte para intervalos não contíguos.

calculate()

Calcula um intervalo de células em uma planilha.

clear(applyTo)

Limpe valores de intervalo, formatação, preenchimento, bordas, etc.

clearAllConditionalFormats()

Limpa todos os formatos condicionais ativos no intervalo atual especificado.

convertDataTypeToText()

Converte o intervalo de células com tipos de dados em texto.

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia a formatação ou dados da célula do intervalo de origem ou de RangeAreas para o intervalo atual. O intervalo de destino pode ser um tamanho diferente do intervalo de origem ou RangeAreas. O destino será expandido automaticamente se for menor do que a origem.

delete(shift)

Exclui as células associadas ao intervalo.

find(text, criteria)

Localiza certa cadeia de caracteres com base em critérios especificados. Se o intervalo atual for maior que uma única célula, a pesquisa será limitada a esse intervalo, caso contrário, a pesquisa cobrirá toda a planilha que começa após essa célula. Se não houver nenhuma correspondência, esta função retornará um objeto NULL.

flashFill()

Faz o preenchimento relâmpago no intervalo atual. O preenchimento relâmpago preenche automaticamente dados quando detecta um padrão. Portanto, o intervalo deve ser de coluna única e ter dados em torno para encontrar o padrão.

getAbsoluteResizedRange(numRows, numColumns)

Obtém um objeto Range com a mesma célula superior esquerda do objeto Range atual, mas com os números especificados de linhas e colunas.

getAddress()

Especifica a referência de intervalo no estilo a1. O valor de endereço conterá a referência de planilha (por exemplo, "Planilha1! A1: B4 ").

getAddressLocal()

Especifica a referência de intervalo para o intervalo especificado no idioma do usuário.

getBoundingRect(anotherRange)

Obtém o menor objeto Range que engloba os intervalos determinados. Por exemplo, o GetBoundingRect de "B2:C5" e "D10:E15" é "B2:E15".

getCell(row, column)

Obtém o objeto de intervalo que contém a célula única com base nos números de linha e de coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que ela permaneça dentro da grade da planilha. A localização da célula retornada está relacionada à célula superior esquerda do intervalo.

getCellCount()

Especifica o número de células no intervalo. Essa API retornará -1 se a contagem de células exceder 2^31-1 (2.147.483.647).

getColumn(column)

Obtém uma coluna incluída no intervalo.

getColumnCount()

Especifica o número total de colunas no intervalo.

getColumnHidden()

Representa se todas as colunas do intervalo atual estão ocultas.

getColumnIndex()

Especifica o número de coluna da primeira célula do intervalo. Indexados com zero.

getColumnsAfter(count)

Obtém um determinado número de colunas à direita do objeto Range atual.

getColumnsBefore(count)

Obtém um determinado número de colunas à esquerda do objeto Range atual.

getConditionalFormat(id)

Retorna um formato condicional para o ID fornecido.

getConditionalFormats()

O conjunto de ConditionalFormats que interseccionam o intervalo.

getDataValidation()

Retorna um objeto de validação de dados.

getDirectPrecedents()

Retorna um objeto WorkbookRangeAreas que representa o intervalo que contém todos os precedentes diretos de uma célula na mesma planilha ou em várias planilhas.

getEntireColumn()

Obtém um objeto que representa a coluna inteira do intervalo (por exemplo, se o intervalo atual representa as células "B4: E11", seu getEntireColumn é um intervalo que representa as colunas "B:E").

getEntireRow()

Obtém um objeto que representa a linha inteira do intervalo (por exemplo, se o intervalo atual representa as células "B4: E11", seu GetEntireRow é um intervalo que representa as linhas "4:11").

getFormat()

Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.

getFormula()

Representa a fórmula da célula em notação de estilo a1. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getFormulaLocal()

Representa a fórmula da célula em notação de estilo a1, no idioma do usuário e na localidade de formatação de números. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getFormulaR1C1()

Representa a fórmula da célula em notação de estilo L1C1. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getFormulas()

Representa a fórmula em notação A1. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

getFormulasLocal()

Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

getFormulasR1C1()

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

getHasSpill()

Representa se todas as células têm uma borda de despejo. Retorna true se todas as células têm uma borda de despejo ou false se todas as células não têm uma borda de despejo. Retorna NULL se houver células com e sem bordas de despejo dentro do intervalo.

getHeight()

Retorna a distância em pontos, para zoom de 100%, da borda superior do intervalo até a borda inferior do intervalo.

getHidden()

Representa se todas as células do intervalo atual estão ocultas.

getHyperlink()

Representa o hiperlink do intervalo atual.

getImage()

Renderiza o intervalo como uma imagem png codificada em base64. Importante: esta API não é suportada atualmente no Excel para Mac. Visite [ OfficeDev/Office-js problema # 235 ] ( https://github.com/OfficeDev/office-js/issues/235) para o status atual.

getIntersection(anotherRange)

Obtém o objeto de intervalo que representa a interseção retangular dos intervalos determinados. Se nenhuma interseção for encontrada, retornará um objeto null.

getIsEntireColumn()

Representa se o intervalo atual está em uma coluna inteira.

getIsEntireRow()

Representa se o intervalo atual está em uma linha inteira.

getLastCell()

Obtém a última célula do intervalo. Por exemplo, a última célula de "B2:D5" é "D5".

getLastColumn()

Obtém a última coluna do intervalo. Por exemplo, a última coluna de "B2:D5" é "D2:D5".

getLastRow()

Obtém a última linha do intervalo. Por exemplo, a última linha de "B2:D5" é "B5:D5".

getLeft()

Retorna a distância em pontos, para zoom de 100%, da borda esquerda da planilha para a borda esquerda do intervalo.

getLinkedDataTypeState()

Representa o estado do tipo de dados da célula.

getLinkedDataTypeStates()

Representa o estado do tipo de dados de cada célula.

getMergedAreas()

Retorna um objeto RangeAreas que representa as áreas mescladas neste intervalo. Observe que, se a contagem de áreas mescladas neste intervalo for maior que 512, a API falhará ao retornar o resultado.

getNumberFormat()

Representa o código de formato de número do Excel da célula para o intervalo especificado. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getNumberFormatCategories()

Representa a categoria do formato de número de cada célula.

getNumberFormatLocal()

Representa o código de formato de número da célula Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não realiza qualquer coerção de idioma ou formatação ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getNumberFormats()

Representa o código de formato de número do Excel para o intervalo especificado.

getNumberFormatsLocal()

Representa o código de formato de número do Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não realiza qualquer coerção de idioma ou formatação ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema.

getOffsetRange(rowOffset, columnOffset)

Obtém um objeto que representa um intervalo deslocado do intervalo especificado. A dimensão do intervalo retornado corresponde a esse intervalo. Se o intervalo resultante for imposto para fora dos limites da grade da planilha, o sistema gerará um erro.

getPivotTables(fullyContained)

Obtém uma coleção com escopo de tabelas dinâmicas que se sobrepõe ao intervalo.

getPredefinedCellStyle()

Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes, NULL será retornado. Para estilos personalizados, o nome do estilo será retornado. Para os estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInstyle será retornada.

getResizedRange(deltaRows, deltaColumns)

Obtém um objeto Range semelhante ao objeto Range atual, mas com seu canto inferior direito expandido (ou recolhido) por um determinado número de linhas e colunas.

getRow(row)

Obtém uma linha contida no intervalo.

getRowCount()

Retorna o número total de linhas no intervalo.

getRowHidden()

Representa se todas as linhas do intervalo atual estão ocultas.

getRowIndex()

Representa o número de linhas da primeira célula no intervalo. Indexados com zero.

getRowsAbove(count)

Obtém um determinado número de linhas acima do objeto Range atual.

getRowsBelow(count)

Obtém um determinado número de linhas abaixo do objeto Range atual.

getSavedAsArray()

Representa se todas as células seriam salvas como uma fórmula de matriz. Retorna true se todas as células forem salvas como uma fórmula de matriz ou false se todas as células não seriam salvas como uma fórmula de matriz. Retorna NULL se algumas células forem salvas como uma fórmula de matriz e algumas não seriam.

getSort()

Representa a classificação de intervalo do intervalo atual.

getSpecialCells(cellType, cellValueType)

Obtém o objeto RangeAreas, compreendendo um ou mais intervalos, que representa todas as células que correspondem ao tipo e valor especificado. Se nenhuma célula especial for encontrada, um objeto NULL será retornado.

getSpillingToRange()

Obtém objeto range que contém o intervalo de despejo quando chamado em uma célula âncora. Se o intervalo não for uma célula de âncora ou um intervalo de despejo não puder ser encontrado, um objeto NULL será retornado.

getSpillParent()

Obtém o objeto range que contém a célula âncora para uma célula que recebe o despejo. Se não for uma célula de despejo ou mais de uma vez, as células serão retornadas.

getSurroundingRegion()

Retorna um objeto Range que representa a região circundante da célula superior esquerda nesse intervalo. Uma região ao redor é um intervalo limitado por qualquer combinação de linhas e colunas em branco em relação a esse intervalo.

getTables(fullyContained)

Obtém uma coleção de tabelas com escopo que se sobrepõe ao intervalo.

getText()

Representa o valor de texto do intervalo especificado. O valor de texto não depende da largura da célula. A # substituição de sinal que acontece na IU do Excel não afetará o valor de texto retornado pela API. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getTexts()

Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A # substituição de sinal que acontece na IU do Excel não afetará o valor de texto retornado pela API.

getTop()

Retorna a distância em pontos, para zoom de 100%, da borda superior da planilha até a borda superior do intervalo.

getUsedRange(valuesOnly)

Retorna o intervalo usado do objeto range determinado. Se não houver nenhuma célula usada no intervalo, esta função retornará um objeto null.

getValue()

Representa o valor bruto do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getValues()

Representa os valores brutos do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro.

getValueType()

Representa o tipo de dados na célula. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getValueTypes()

Especifica o tipo de dados em cada célula.

getVisibleView()

Representa as linhas visíveis do intervalo atual.

getWidth()

Retorna a distância em pontos, para zoom de 100%, da borda esquerda do intervalo até a borda direita do intervalo.

getWorksheet()

A planilha que contém o intervalo atual.

group(groupOption)

Agrupa colunas e linhas de uma estrutura de tópicos.

hideGroupDetails(groupOption)

Ocultar detalhes do grupo de linhas ou colunas.

insert(shift)

Insere uma célula ou um intervalo de células na planilha, no lugar desse intervalo, e desloca as outras células para liberar espaço. Retorna um novo objeto Range no espaço em branco atual.

merge(across)

Mescla as células do intervalo em uma região da planilha.

moveTo(destinationRange)

Move valores de célula, formatação e fórmulas do intervalo atual para o intervalo de destino, substituindo as informações antigas nessas células. O intervalo de destino será expandido automaticamente se for menor do que o intervalo atual. As células no intervalo de destino que estão fora da área do intervalo original não são alteradas.

removeDuplicates(columns, includesHeader)

Remove valores duplicados do intervalo especificado pelas colunas.

replaceAll(text, replacement, criteria)

Localiza e substitui a cadeia de caracteres fornecida com base nos critérios especificados no intervalo atual.

select()

Seleciona o intervalo especificado na interface do usuário do Excel.

setColumnHidden(columnHidden)

Representa se todas as colunas do intervalo atual estão ocultas.

setDirty()

Define um intervalo a ser recalculado quando o próximo recálculo ocorrer.

setFormula(formula)

Define a fórmula da célula em notação de estilo a1. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setFormulaLocal(formulaLocal)

Definir a fórmula da célula em notação de estilo a1, no idioma do usuário e na localidade de formatação de números. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setFormulaR1C1(formulaR1C1)

Define a fórmula da célula em notação de estilo L1C1. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setFormulas(formulas)

Representa a fórmula em notação A1. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

setFormulasLocal(formulasLocal)

Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

setFormulasR1C1(formulasR1C1)

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

setHyperlink(hyperlink)

Representa o hiperlink do intervalo atual.

setNumberFormat(numberFormat)

Define o código de formato de número da célula Excel para o intervalo especificado. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setNumberFormatLocal(numberFormatLocal)

Define o código de formato de número da célula Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não realiza qualquer coerção de idioma ou formatação ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setNumberFormats(numberFormats)

Representa o código de formato de número do Excel para o intervalo especificado.

setNumberFormatsLocal(numberFormatsLocal)

Representa o código de formato de número do Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não realiza qualquer coerção de idioma ou formatação ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema.

setPredefinedCellStyle(predefinedCellStyle)

Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes, NULL será retornado. Para estilos personalizados, o nome do estilo será retornado. Para os estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInstyle será retornada.

setRowHidden(rowHidden)

Representa se todas as linhas do intervalo atual estão ocultas.

setValue(value)

Define o valor bruto do intervalo especificado. Os dados que estão sendo definidos podem ser do tipo String, Number ou Boolean. null o valor será ignorado (não definido ou substituído no Excel). Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setValues(values)

Representa os valores brutos do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro.

showCard()

Exibe o cartão para uma célula ativa se ele tiver um conteúdo valioso.

showGroupDetails(groupOption)

Mostrar detalhes do grupo de linhas ou colunas.

ungroup(groupOption)

Desagrupa colunas e linhas de uma estrutura de tópicos.

unmerge()

Desfaz a mesclagem das células do intervalo em células separadas.

Detalhes do método

addConditionalFormat(type)

Adiciona um novo formato condicional à coleção na prioridade First/Top.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Parâmetros

type
ConditionalFormatType

O tipo de formato condicional que está sendo adicionado. Consulte ExcelScript. Valorconditionalformattype para obter detalhes.

Retornos

Exemplos

/**
 * This sample applies conditional formatting to the currently used range in the worksheet. 
 * The conditional formatting is a green fill for the top 10% of values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the used range in the worksheet.
  let range = selectedSheet.getUsedRange();

  // Set the fill color to green for the top 10% of values in the range.
  let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
  conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
  conditionalFormat.getTopBottom().setRule({
    rank: 10, // The percentage threshold.
    type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The type of the top/bottom condition.
  });
}

autoFill(destinationRange, autoFillType)

Preenche o intervalo do intervalo atual com o intervalo de destino especificado usando a lógica de preenchimento automático especificada. O intervalo de destino pode ser nulo, ou pode estender a fonte horizontal ou verticalmente. Não há suporte para intervalos não contíguos.

autoFill(
            destinationRange?: Range | string,
            autoFillType?: AutoFillType
        ): void;

Parâmetros

destinationRange
Range | string

O intervalo de destino para preenchimento automático. Se o intervalo de destino for nulo, os dados serão preenchidos com base nas células ao redor (que é o comportamento ao clicar duas vezes na alça de preenchimento do intervalo da interface do usuário).

autoFillType
AutoFillType

O tipo de preenchimento automático. Especifica como o intervalo de destino deve ser preenchido, com base no conteúdo do intervalo atual. O padrão é "FillDefault".

Retornos

void

calculate()

Calcula um intervalo de células em uma planilha.

calculate(): void;

Retornos

void

clear(applyTo)

Limpe valores de intervalo, formatação, preenchimento, bordas, etc.

clear(applyTo?: ClearApplyTo): void;

Parâmetros

applyTo
ClearApplyTo

Opcional. Determina o tipo de ação clara. Consulte ExcelScript. ClearApplyTo para obter detalhes.

Retornos

void

Exemplos

/**
 * This script removes all the formatting from the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let range = workbook.getSelectedRange();

  // Clear all the formatting in that range.
  range.clear(ExcelScript.ClearApplyTo.formats);
}

clearAllConditionalFormats()

Limpa todos os formatos condicionais ativos no intervalo atual especificado.

clearAllConditionalFormats(): void;

Retornos

void

convertDataTypeToText()

Converte o intervalo de células com tipos de dados em texto.

convertDataTypeToText(): void;

Retornos

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia a formatação ou dados da célula do intervalo de origem ou de RangeAreas para o intervalo atual. O intervalo de destino pode ser um tamanho diferente do intervalo de origem ou RangeAreas. O destino será expandido automaticamente se for menor do que a origem.

copyFrom(
            sourceRange: Range | RangeAreas | string,
            copyType?: RangeCopyType,
            skipBlanks?: boolean,
            transpose?: boolean
        ): void;

Parâmetros

sourceRange
Range | RangeAreas | string

O intervalo de origem ou RangeAreas a ser copiado. Quando o RangeAreas de origem tem vários intervalos, seu formulário deve poder ser criado removendo linhas ou colunas completas de um intervalo retangular.

copyType
RangeCopyType

O tipo de dados da célula ou formatação a ser copiada. O padrão é "All".

skipBlanks
boolean

True se para ignorar células em branco no intervalo de origem. O padrão é false.

transpose
boolean

True se para transpor as células no intervalo de destino. O padrão é false.

Retornos

void

delete(shift)

Exclui as células associadas ao intervalo.

delete(shift: DeleteShiftDirection): void;

Parâmetros

shift
DeleteShiftDirection

Especifica como deslocar as células. Consulte ExcelScript. DeleteShiftDirection para obter detalhes.

Retornos

void

find(text, criteria)

Localiza certa cadeia de caracteres com base em critérios especificados. Se o intervalo atual for maior que uma única célula, a pesquisa será limitada a esse intervalo, caso contrário, a pesquisa cobrirá toda a planilha que começa após essa célula. Se não houver nenhuma correspondência, esta função retornará um objeto NULL.

find(text: string, criteria: SearchCriteria): Range;

Parâmetros

text
string

A cadeia de caracteres a ser localizada.

criteria
SearchCriteria

Critérios de pesquisa adicionais, incluindo a direção da pesquisa e se a pesquisa precisa corresponder à célula inteira ou diferenciar maiúsculas de minúsculas.

Retornos

flashFill()

Faz o preenchimento relâmpago no intervalo atual. O preenchimento relâmpago preenche automaticamente dados quando detecta um padrão. Portanto, o intervalo deve ser de coluna única e ter dados em torno para encontrar o padrão.

flashFill(): void;

Retornos

void

getAbsoluteResizedRange(numRows, numColumns)

Obtém um objeto Range com a mesma célula superior esquerda do objeto Range atual, mas com os números especificados de linhas e colunas.

getAbsoluteResizedRange(numRows: number, numColumns: number): Range;

Parâmetros

numRows
number

O número de linhas do novo tamanho de intervalo.

numColumns
number

O número de colunas do novo tamanho de intervalo.

Retornos

getAddress()

Especifica a referência de intervalo no estilo a1. O valor de endereço conterá a referência de planilha (por exemplo, "Planilha1! A1: B4 ").

getAddress(): string;

Retornos

string

getAddressLocal()

Especifica a referência de intervalo para o intervalo especificado no idioma do usuário.

getAddressLocal(): string;

Retornos

string

getBoundingRect(anotherRange)

Obtém o menor objeto Range que engloba os intervalos determinados. Por exemplo, o GetBoundingRect de "B2:C5" e "D10:E15" é "B2:E15".

getBoundingRect(anotherRange: Range | string): Range;

Parâmetros

anotherRange
Range | string

O nome ou endereço do intervalo ou o objeto Range.

Retornos

getCell(row, column)

Obtém o objeto de intervalo que contém a célula única com base nos números de linha e de coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que ela permaneça dentro da grade da planilha. A localização da célula retornada está relacionada à célula superior esquerda do intervalo.

getCell(row: number, column: number): Range;

Parâmetros

row
number

O número da linha da célula a ser recuperada. Indexados com zero.

column
number

O número da coluna da célula a ser recuperada. Indexados com zero.

Retornos

getCellCount()

Especifica o número de células no intervalo. Essa API retornará -1 se a contagem de células exceder 2^31-1 (2.147.483.647).

getCellCount(): number;

Retornos

number

getColumn(column)

Obtém uma coluna incluída no intervalo.

getColumn(column: number): Range;

Parâmetros

column
number

O número da coluna do intervalo a ser recuperado. Indexados com zero.

Retornos

getColumnCount()

Especifica o número total de colunas no intervalo.

getColumnCount(): number;

Retornos

number

Exemplos

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getColumnHidden()

Representa se todas as colunas do intervalo atual estão ocultas.

getColumnHidden(): boolean;

Retornos

boolean

getColumnIndex()

Especifica o número de coluna da primeira célula do intervalo. Indexados com zero.

getColumnIndex(): number;

Retornos

number

getColumnsAfter(count)

Obtém um determinado número de colunas à direita do objeto Range atual.

getColumnsAfter(count?: number): Range;

Parâmetros

count
number

Opcional. O número de colunas a serem incluídas no intervalo resultante. Em geral, use um número positivo para criar um intervalo fora do intervalo atual. Você também pode usar um número negativo para criar um intervalo dentro do intervalo atual. O valor padrão é 1.

Retornos

getColumnsBefore(count)

Obtém um determinado número de colunas à esquerda do objeto Range atual.

getColumnsBefore(count?: number): Range;

Parâmetros

count
number

Opcional. O número de colunas a serem incluídas no intervalo resultante. Em geral, use um número positivo para criar um intervalo fora do intervalo atual. Você também pode usar um número negativo para criar um intervalo dentro do intervalo atual. O valor padrão é 1.

Retornos

getConditionalFormat(id)

Retorna um formato condicional para o ID fornecido.

getConditionalFormat(id: string): ConditionalFormat;

Parâmetros

id
string

A ID da formatação condicional.

Retornos

getConditionalFormats()

O conjunto de ConditionalFormats que interseccionam o intervalo.

getConditionalFormats(): ConditionalFormat[];

Retornos

getDataValidation()

Retorna um objeto de validação de dados.

getDataValidation(): DataValidation;

Retornos

getDirectPrecedents()

Retorna um objeto WorkbookRangeAreas que representa o intervalo que contém todos os precedentes diretos de uma célula na mesma planilha ou em várias planilhas.

getDirectPrecedents(): WorkbookRangeAreas;

Retornos

getEntireColumn()

Obtém um objeto que representa a coluna inteira do intervalo (por exemplo, se o intervalo atual representa as células "B4: E11", seu getEntireColumn é um intervalo que representa as colunas "B:E").

getEntireColumn(): Range;

Retornos

getEntireRow()

Obtém um objeto que representa a linha inteira do intervalo (por exemplo, se o intervalo atual representa as células "B4: E11", seu GetEntireRow é um intervalo que representa as linhas "4:11").

getEntireRow(): Range;

Retornos

getFormat()

Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.

getFormat(): RangeFormat;

Retornos

getFormula()

Representa a fórmula da célula em notação de estilo a1. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getFormula(): string;

Retornos

string

Exemplos

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

getFormulaLocal()

Representa a fórmula da célula em notação de estilo a1, no idioma do usuário e na localidade de formatação de números. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getFormulaLocal(): string;

Retornos

string

getFormulaR1C1()

Representa a fórmula da célula em notação de estilo L1C1. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getFormulaR1C1(): string;

Retornos

string

getFormulas()

Representa a fórmula em notação A1. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

getFormulas(): string[][];

Retornos

string[][]

getFormulasLocal()

Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

getFormulasLocal(): string[][];

Retornos

string[][]

getFormulasR1C1()

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

getFormulasR1C1(): string[][];

Retornos

string[][]

getHasSpill()

Representa se todas as células têm uma borda de despejo. Retorna true se todas as células têm uma borda de despejo ou false se todas as células não têm uma borda de despejo. Retorna NULL se houver células com e sem bordas de despejo dentro do intervalo.

getHasSpill(): boolean;

Retornos

boolean

getHeight()

Retorna a distância em pontos, para zoom de 100%, da borda superior do intervalo até a borda inferior do intervalo.

getHeight(): number;

Retornos

number

getHidden()

Representa se todas as células do intervalo atual estão ocultas.

getHidden(): boolean;

Retornos

boolean

Representa o hiperlink do intervalo atual.

getHyperlink(): RangeHyperlink;

Retornos

getImage()

Renderiza o intervalo como uma imagem png codificada em base64. Importante: esta API não é suportada atualmente no Excel para Mac. Visite [ OfficeDev/Office-js problema # 235 ] ( https://github.com/OfficeDev/office-js/issues/235) para o status atual.

getImage(): string;

Retornos

string

getIntersection(anotherRange)

Obtém o objeto de intervalo que representa a interseção retangular dos intervalos determinados. Se nenhuma interseção for encontrada, retornará um objeto null.

getIntersection(anotherRange: Range | string): Range;

Parâmetros

anotherRange
Range | string

O objeto Range ou o endereço do intervalo que será usado para determinar a interseção de intervalos.

Retornos

getIsEntireColumn()

Representa se o intervalo atual está em uma coluna inteira.

getIsEntireColumn(): boolean;

Retornos

boolean

getIsEntireRow()

Representa se o intervalo atual está em uma linha inteira.

getIsEntireRow(): boolean;

Retornos

boolean

getLastCell()

Obtém a última célula do intervalo. Por exemplo, a última célula de "B2:D5" é "D5".

getLastCell(): Range;

Retornos

getLastColumn()

Obtém a última coluna do intervalo. Por exemplo, a última coluna de "B2:D5" é "D2:D5".

getLastColumn(): Range;

Retornos

getLastRow()

Obtém a última linha do intervalo. Por exemplo, a última linha de "B2:D5" é "B5:D5".

getLastRow(): Range;

Retornos

getLeft()

Retorna a distância em pontos, para zoom de 100%, da borda esquerda da planilha para a borda esquerda do intervalo.

getLeft(): number;

Retornos

number

getLinkedDataTypeState()

Representa o estado do tipo de dados da célula.

getLinkedDataTypeState(): LinkedDataTypeState;

Retornos

getLinkedDataTypeStates()

Representa o estado do tipo de dados de cada célula.

getLinkedDataTypeStates(): LinkedDataTypeState[][];

Retornos

getMergedAreas()

Retorna um objeto RangeAreas que representa as áreas mescladas neste intervalo. Observe que, se a contagem de áreas mescladas neste intervalo for maior que 512, a API falhará ao retornar o resultado.

getMergedAreas(): RangeAreas;

Retornos

getNumberFormat()

Representa o código de formato de número do Excel da célula para o intervalo especificado. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getNumberFormat(): string;

Retornos

string

getNumberFormatCategories()

Representa a categoria do formato de número de cada célula.

getNumberFormatCategories(): NumberFormatCategory[][];

Retornos

getNumberFormatLocal()

Representa o código de formato de número da célula Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não realiza qualquer coerção de idioma ou formatação ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getNumberFormatLocal(): string;

Retornos

string

getNumberFormats()

Representa o código de formato de número do Excel para o intervalo especificado.

getNumberFormats(): string[][];

Retornos

string[][]

getNumberFormatsLocal()

Representa o código de formato de número do Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não realiza qualquer coerção de idioma ou formatação ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema.

getNumberFormatsLocal(): string[][];

Retornos

string[][]

getOffsetRange(rowOffset, columnOffset)

Obtém um objeto que representa um intervalo deslocado do intervalo especificado. A dimensão do intervalo retornado corresponde a esse intervalo. Se o intervalo resultante for imposto para fora dos limites da grade da planilha, o sistema gerará um erro.

getOffsetRange(rowOffset: number, columnOffset: number): Range;

Parâmetros

rowOffset
number

O número de linhas (positivo, negativo ou 0) com base no qual o intervalo deve ser deslocado. Os valores positivos são deslocados para baixo e os negativos, para cima.

columnOffset
number

O número de colunas (positivo, negativo ou 0) com base no qual o intervalo deve ser deslocado. Os valores positivos são deslocados para a direita e os negativos, para a esquerda.

Retornos

Exemplos

/**
 * This script gets adjacent cells using relative references.
 * Note that if the active cell is on the top row, part of the script fails, 
 * because it references the cell above the currently selected one.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the currently active cell in the workbook.
  let activeCell = workbook.getActiveCell();
  console.log(`The active cell's address is: ${activeCell.getAddress()}`);

  // Get the cell to the right of the active cell and set its value and color.
  let rightCell = activeCell.getOffsetRange(0,1);
  rightCell.setValue("Right cell");
  console.log(`The right cell's address is: ${rightCell.getAddress()}`);
  rightCell.getFormat().getFont().setColor("Magenta");
  rightCell.getFormat().getFill().setColor("Cyan");

  // Get the cell to the above of the active cell and set its value and color.
  // Note that this operation will fail if the active cell is in the top row.
  let aboveCell = activeCell.getOffsetRange(-1, 0);
  aboveCell.setValue("Above cell");
  console.log(`The above cell's address is: ${aboveCell.getAddress()}`);
  aboveCell.getFormat().getFont().setColor("White");
  aboveCell.getFormat().getFill().setColor("Black");
}

getPivotTables(fullyContained)

Obtém uma coleção com escopo de tabelas dinâmicas que se sobrepõe ao intervalo.

getPivotTables(fullyContained?: boolean): PivotTable[];

Parâmetros

fullyContained
boolean

Se true, retornará somente as tabelas dinâmicas que estão totalmente contidas dentro dos limites do intervalo. O valor padrão é falso.

Retornos

getPredefinedCellStyle()

Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes, NULL será retornado. Para estilos personalizados, o nome do estilo será retornado. Para os estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInstyle será retornada.

getPredefinedCellStyle(): string;

Retornos

string

getResizedRange(deltaRows, deltaColumns)

Obtém um objeto Range semelhante ao objeto Range atual, mas com seu canto inferior direito expandido (ou recolhido) por um determinado número de linhas e colunas.

getResizedRange(deltaRows: number, deltaColumns: number): Range;

Parâmetros

deltaRows
number

O número de linhas pelo qual expandir o canto inferior direito, referente ao intervalo atual. Use um número positivo para expandir o intervalo ou um número negativo para diminuí-lo.

deltaColumns
number

O número de colunas pelas quais expandir o canto inferior direito, em relação ao intervalo atual. Use um número positivo para expandir o intervalo ou um número negativo para diminuí-lo.

Retornos

Exemplos

/**
 * This script copies the formatting in the active cell to the neighboring cells.
 * Note that this script only works when the active cell isn't on an edge of the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let activeCell = workbook.getActiveCell();

  // Get the cell that's one row above and one column to the left of the active cell.
  let cornerCell = activeCell.getOffsetRange(-1,-1);

  // Get a range that includes all the cells surrounding the active cell.
  let surroundingRange = cornerCell.getResizedRange(2, 2)

  // Copy the formatting from the active cell to the new range.
  surroundingRange.copyFrom(
    activeCell, /* The source range. */
    ExcelScript.RangeCopyType.formats /* What to copy. */
    );
}

getRow(row)

Obtém uma linha contida no intervalo.

getRow(row: number): Range;

Parâmetros

row
number

O número da linha do intervalo a ser recuperado. Indexados com zero.

Retornos

getRowCount()

Retorna o número total de linhas no intervalo.

getRowCount(): number;

Retornos

number

Exemplos

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getRowHidden()

Representa se todas as linhas do intervalo atual estão ocultas.

getRowHidden(): boolean;

Retornos

boolean

getRowIndex()

Representa o número de linhas da primeira célula no intervalo. Indexados com zero.

getRowIndex(): number;

Retornos

number

getRowsAbove(count)

Obtém um determinado número de linhas acima do objeto Range atual.

getRowsAbove(count?: number): Range;

Parâmetros

count
number

Opcional. O número de linhas a serem incluídas no intervalo resultante. Em geral, use um número positivo para criar um intervalo fora do intervalo atual. Você também pode usar um número negativo para criar um intervalo dentro do intervalo atual. O valor padrão é 1.

Retornos

getRowsBelow(count)

Obtém um determinado número de linhas abaixo do objeto Range atual.

getRowsBelow(count?: number): Range;

Parâmetros

count
number

Opcional. O número de linhas a serem incluídas no intervalo resultante. Em geral, use um número positivo para criar um intervalo fora do intervalo atual. Você também pode usar um número negativo para criar um intervalo dentro do intervalo atual. O valor padrão é 1.

Retornos

getSavedAsArray()

Representa se todas as células seriam salvas como uma fórmula de matriz. Retorna true se todas as células forem salvas como uma fórmula de matriz ou false se todas as células não seriam salvas como uma fórmula de matriz. Retorna NULL se algumas células forem salvas como uma fórmula de matriz e algumas não seriam.

getSavedAsArray(): boolean;

Retornos

boolean

getSort()

Representa a classificação de intervalo do intervalo atual.

getSort(): RangeSort;

Retornos

getSpecialCells(cellType, cellValueType)

Obtém o objeto RangeAreas, compreendendo um ou mais intervalos, que representa todas as células que correspondem ao tipo e valor especificado. Se nenhuma célula especial for encontrada, um objeto NULL será retornado.

getSpecialCells(
            cellType: SpecialCellType,
            cellValueType?: SpecialCellValueType
        ): RangeAreas;

Parâmetros

cellType
SpecialCellType

O tipo de células a serem incluídas.

cellValueType
SpecialCellValueType

Se CellType for Constants ou formulas, esse argumento será usado para determinar quais tipos de células incluir no resultado. Esses valores podem ser combinados em conjunto para retornar mais de um tipo. O padrão é selecionar todas as constantes ou as fórmulas, independente do tipo.

Retornos

getSpillingToRange()

Obtém objeto range que contém o intervalo de despejo quando chamado em uma célula âncora. Se o intervalo não for uma célula de âncora ou um intervalo de despejo não puder ser encontrado, um objeto NULL será retornado.

getSpillingToRange(): Range;

Retornos

getSpillParent()

Obtém o objeto range que contém a célula âncora para uma célula que recebe o despejo. Se não for uma célula de despejo ou mais de uma vez, as células serão retornadas.

getSpillParent(): Range;

Retornos

getSurroundingRegion()

Retorna um objeto Range que representa a região circundante da célula superior esquerda nesse intervalo. Uma região ao redor é um intervalo limitado por qualquer combinação de linhas e colunas em branco em relação a esse intervalo.

getSurroundingRegion(): Range;

Retornos

getTables(fullyContained)

Obtém uma coleção de tabelas com escopo que se sobrepõe ao intervalo.

getTables(fullyContained?: boolean): Table[];

Parâmetros

fullyContained
boolean

Se true, retornará somente as tabelas que estão totalmente contidas dentro dos limites do intervalo. O valor padrão é falso.

Retornos

Table[]

getText()

Representa o valor de texto do intervalo especificado. O valor de texto não depende da largura da célula. A # substituição de sinal que acontece na IU do Excel não afetará o valor de texto retornado pela API. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getText(): string;

Retornos

string

getTexts()

Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A # substituição de sinal que acontece na IU do Excel não afetará o valor de texto retornado pela API.

getTexts(): string[][];

Retornos

string[][]

getTop()

Retorna a distância em pontos, para zoom de 100%, da borda superior da planilha até a borda superior do intervalo.

getTop(): number;

Retornos

number

getUsedRange(valuesOnly)

Retorna o intervalo usado do objeto range determinado. Se não houver nenhuma célula usada no intervalo, esta função retornará um objeto null.

getUsedRange(valuesOnly?: boolean): Range;

Parâmetros

valuesOnly
boolean

Considera apenas as células com valores como células usadas.

Retornos

getValue()

Representa o valor bruto do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getValue(): any;

Retornos

any

Exemplos

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

getValues()

Representa os valores brutos do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro.

getValues(): any[][];

Retornos

any[][]

getValueType()

Representa o tipo de dados na célula. Se o intervalo contiver várias células, os dados da primeira célula (representados pelo índice de linha 0 e o índice de coluna 0) serão retornados.

getValueType(): RangeValueType;

Retornos

getValueTypes()

Especifica o tipo de dados em cada célula.

getValueTypes(): RangeValueType[][];

Retornos

getVisibleView()

Representa as linhas visíveis do intervalo atual.

getVisibleView(): RangeView;

Retornos

getWidth()

Retorna a distância em pontos, para zoom de 100%, da borda esquerda do intervalo até a borda direita do intervalo.

getWidth(): number;

Retornos

number

getWorksheet()

A planilha que contém o intervalo atual.

getWorksheet(): Worksheet;

Retornos

group(groupOption)

Agrupa colunas e linhas de uma estrutura de tópicos.

group(groupOption: GroupOption): void;

Parâmetros

groupOption
GroupOption

Especifica como o intervalo pode ser agrupado por linhas ou colunas. Um InvalidArgument erro é acionado quando a opção de grupo difere da isEntireRow propriedade ou do intervalo isEntireColumn (ou seja, range.isEntireRow é true e groupOption é "ByColumns" ou range.isEntireColumn true e groupOption é "ByRows").

Retornos

void

hideGroupDetails(groupOption)

Ocultar detalhes do grupo de linhas ou colunas.

hideGroupDetails(groupOption: GroupOption): void;

Parâmetros

groupOption
GroupOption

Especifica se é para ocultar detalhes de linhas agrupadas ou colunas agrupadas.

Retornos

void

insert(shift)

Insere uma célula ou um intervalo de células na planilha, no lugar desse intervalo, e desloca as outras células para liberar espaço. Retorna um novo objeto Range no espaço em branco atual.

insert(shift: InsertShiftDirection): Range;

Parâmetros

shift
InsertShiftDirection

Especifica como deslocar as células. Consulte ExcelScript. InsertShiftDirection para obter detalhes.

Retornos

merge(across)

Mescla as células do intervalo em uma região da planilha.

merge(across?: boolean): void;

Parâmetros

across
boolean

Opcional. Defina true para mesclar células em todas as linhas do intervalo especificado como células mescladas separadamente. O valor padrão é false.

Retornos

void

moveTo(destinationRange)

Move valores de célula, formatação e fórmulas do intervalo atual para o intervalo de destino, substituindo as informações antigas nessas células. O intervalo de destino será expandido automaticamente se for menor do que o intervalo atual. As células no intervalo de destino que estão fora da área do intervalo original não são alteradas.

moveTo(destinationRange: Range | string): void;

Parâmetros

destinationRange
Range | string

destinationRange especifica o intervalo no qual as informações neste intervalo serão movidas.

Retornos

void

removeDuplicates(columns, includesHeader)

Remove valores duplicados do intervalo especificado pelas colunas.

removeDuplicates(
            columns: number[],
            includesHeader: boolean
        ): RemoveDuplicatesResult;

Parâmetros

columns
number[]

As colunas dentro do intervalo que podem conter duplicatas. É necessário especificar pelo menos uma coluna. Indexados com zero.

includesHeader
boolean

True se os dados de entrada contêm cabeçalho. O padrão é false.

Retornos

replaceAll(text, replacement, criteria)

Localiza e substitui a cadeia de caracteres fornecida com base nos critérios especificados no intervalo atual.

replaceAll(
            text: string,
            replacement: string,
            criteria: ReplaceCriteria
        ): number;

Parâmetros

text
string

Cadeia de caracteres a ser localizada.

replacement
string

Cadeia de caracteres para substituir o original por.

criteria
ReplaceCriteria

Critérios adicionais de substituição.

Retornos

number

select()

Seleciona o intervalo especificado na interface do usuário do Excel.

select(): void;

Retornos

void

setColumnHidden(columnHidden)

Representa se todas as colunas do intervalo atual estão ocultas.

setColumnHidden(columnHidden: boolean): void;

Parâmetros

columnHidden
boolean

Retornos

void

setDirty()

Define um intervalo a ser recalculado quando o próximo recálculo ocorrer.

setDirty(): void;

Retornos

void

setFormula(formula)

Define a fórmula da célula em notação de estilo a1. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setFormula(formula: string): void;

Parâmetros

formula
string

Retornos

void

Exemplos

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

setFormulaLocal(formulaLocal)

Definir a fórmula da célula em notação de estilo a1, no idioma do usuário e na localidade de formatação de números. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setFormulaLocal(formulaLocal: string): void;

Parâmetros

formulaLocal
string

Retornos

void

setFormulaR1C1(formulaR1C1)

Define a fórmula da célula em notação de estilo L1C1. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setFormulaR1C1(formulaR1C1: string): void;

Parâmetros

formulaR1C1
string

Retornos

void

setFormulas(formulas)

Representa a fórmula em notação A1. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

setFormulas(formulas: string[][]): void;

Parâmetros

formulas
string[][]

Retornos

void

setFormulasLocal(formulasLocal)

Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

setFormulasLocal(formulasLocal: string[][]): void;

Parâmetros

formulasLocal
string[][]

Retornos

void

setFormulasR1C1(formulasR1C1)

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver uma fórmula, seu valor será retornado em vez disso.

setFormulasR1C1(formulasR1C1: string[][]): void;

Parâmetros

formulasR1C1
string[][]

Retornos

void

Representa o hiperlink do intervalo atual.

setHyperlink(hyperlink: RangeHyperlink): void;

Parâmetros

hyperlink
RangeHyperlink

Retornos

void

Exemplos

/** 
 * This script inserts a hyperlink to the first cell of the last worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let cell = workbook.getActiveCell();

  // Get the last worksheet in the workbook.
  // Note that this might be the current sheet if there's only one worksheet.
  let lastSheet = workbook.getLastWorksheet();

  // Get sheet name. 
  let linkedSheetName = lastSheet.getName();
  console.log(`Setting hyperlink of ${cell.getAddress()} to the ${linkedSheetName} sheet's A1 cell`);

  // Set the text for the hyperlink.
  let value = `Click to go to: ${linkedSheetName}`;

  // Create the hyperlink using that cell's value.
  cell.setHyperlink({
    textToDisplay: value.toString(),
    screenTip: `Navigate to ${linkedSheetName}`,
    documentReference: `${linkedSheetName}!A1`
  });
}

setNumberFormat(numberFormat)

Define o código de formato de número da célula Excel para o intervalo especificado. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setNumberFormat(numberFormat: string): void;

Parâmetros

numberFormat
string

Retornos

void

setNumberFormatLocal(numberFormatLocal)

Define o código de formato de número da célula Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não realiza qualquer coerção de idioma ou formatação ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema. Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setNumberFormatLocal(numberFormatLocal: string): void;

Parâmetros

numberFormatLocal
string

Retornos

void

setNumberFormats(numberFormats)

Representa o código de formato de número do Excel para o intervalo especificado.

setNumberFormats(numberFormats: string[][]): void;

Parâmetros

numberFormats
string[][]

Retornos

void

setNumberFormatsLocal(numberFormatsLocal)

Representa o código de formato de número do Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não realiza qualquer coerção de idioma ou formatação ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema.

setNumberFormatsLocal(numberFormatsLocal: string[][]): void;

Parâmetros

numberFormatsLocal
string[][]

Retornos

void

setPredefinedCellStyle(predefinedCellStyle)

Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes, NULL será retornado. Para estilos personalizados, o nome do estilo será retornado. Para os estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInstyle será retornada.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Parâmetros

predefinedCellStyle
string

Retornos

void

setRowHidden(rowHidden)

Representa se todas as linhas do intervalo atual estão ocultas.

setRowHidden(rowHidden: boolean): void;

Parâmetros

rowHidden
boolean

Retornos

void

setValue(value)

Define o valor bruto do intervalo especificado. Os dados que estão sendo definidos podem ser do tipo String, Number ou Boolean. null o valor será ignorado (não definido ou substituído no Excel). Se o intervalo contiver várias células, cada célula no intervalo determinado será atualizada com os dados de entrada.

setValue(value: any): void;

Parâmetros

value
any

Retornos

void

setValues(values)

Representa os valores brutos do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro.

setValues(values: any[][]): void;

Parâmetros

values
any[][]

Retornos

void

Exemplos

/**
 * This sample inserts some pre-loaded data into a range.
 * It also shows how to get a range that fits the data.
 */
 function main(workbook: ExcelScript.Workbook) {
   // Get the active cell.
   let currentCell = workbook.getActiveCell();
   
   // Calculate the range needed to fit the given data.
   let targetRange = currentCell.getResizedRange(DATA.length - 1, DATA[0].length - 1);

   // Set range values to the data.
   targetRange.setValues(DATA);

   // Autofit the columns so the worksheet is readable. 
   targetRange.getFormat().autofitColumns();
 }

 /* 
  * This sample's data is in a static 2-dimensional array.
  * You could also get the input from other ranges or sources.
  * Note that each row must have the same number of columns to be valid. 
  */
 const DATA = [
   ['Date', 'Salesperson', 'Product', 'Amount']
   , ['3/2/2020', 'Anne', 'Pizza', '$1400']
   , ['3/2/2020', 'Mariya', 'Pizza', '$1700']
   , ['3/7/2020', 'Mark', 'Sandwiches', '$1010']
   , ['3/24/2020', 'Anne', 'Pizza', '$750']
   , ['3/28/2020', 'Mark', 'Salads', '$510']
   , ['4/17/2020', 'Laura', 'Salads', '$900']
   , ['4/17/2020', 'Mariya', 'Salads', '$1600']
   , ['4/28/2020', 'Laura', 'Sandwiches', '$680']
 ];

showCard()

Exibe o cartão para uma célula ativa se ele tiver um conteúdo valioso.

showCard(): void;

Retornos

void

showGroupDetails(groupOption)

Mostrar detalhes do grupo de linhas ou colunas.

showGroupDetails(groupOption: GroupOption): void;

Parâmetros

groupOption
GroupOption

Especifica se é para mostrar detalhes de linhas agrupadas ou colunas agrupadas.

Retornos

void

ungroup(groupOption)

Desagrupa colunas e linhas de uma estrutura de tópicos.

ungroup(groupOption: GroupOption): void;

Parâmetros

groupOption
GroupOption

Especifica como o intervalo pode ser desagrupado por linhas ou colunas.

Retornos

void

unmerge()

Desfaz a mesclagem das células do intervalo em células separadas.

unmerge(): void;

Retornos

void