Excel.Range class

Intervalo representa um conjunto de uma ou mais células contíguas, como uma célula, uma linha, uma coluna ou um bloco de células. Para saber mais sobre como os intervalos são usados na API, comece com Intervalos na API JavaScript do Excel.

Comentários

[Conjunto de apis: ExcelApi 1.1]

Propriedades

address	Especifica a referência de intervalo no estilo A1. O valor do endereço contém a referência de planilha (por exemplo, "Planilha1! A1:B4").
addressLocal	Representa a referência de intervalo para o intervalo especificado no idioma do usuário.
cellCount	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).
columnCount	Especifica o número total de colunas no intervalo.
columnHidden	Representa se todas as colunas no intervalo atual estão ocultas. Valor é `true` quando todas as colunas em um intervalo estão ocultas. Valor é `false` quando nenhuma coluna no intervalo está oculta. Valor é `null` quando algumas colunas em um intervalo estão ocultas e outras colunas no mesmo intervalo não estão ocultas.
columnIndex	Especifica o número da coluna da primeira célula do intervalo. Indexados com zero.
conditionalFormats	A coleção dessa `ConditionalFormats` interseção a cordilheira.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
control	Acessa o controle de célula aplicado a esse intervalo. Se o intervalo tiver vários controles de célula, isso retornará `EmptyCellControl`.
dataValidation	Retorna um objeto de validação de dados.
format	Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.
formulas	Representa a fórmula em notação A1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.
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 fórmula, seu valor será retornado em vez disso.
formulasR1C1	Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.
hasSpill	Representa se todas as células têm uma borda de despejo. Retorna `true` se todas as células tiverem uma borda de despejo ou `false` se todas as células não tiverem uma borda de despejo. Retorna `null` se houver células com e sem bordas de despejo dentro do intervalo.
height	Retorna a distância em pontos, para um zoom de 100%, da borda superior do intervalo até a borda inferior do intervalo.
hidden	Representa se todas as células no intervalo atual estão ocultas. Valor é `true` quando todas as células em um intervalo estão ocultas. Valor é `false` quando nenhuma célula do intervalo está oculta. O valor é `null` quando algumas células de um intervalo estão ocultas e outras células do mesmo intervalo não estão ocultas.
hyperlink	Representa o hiperlink para o intervalo atual.
isEntireColumn	Representa se o intervalo atual está em uma coluna inteira.
isEntireRow	Representa se o intervalo atual está em uma linha inteira.
left	Retorna a distância em pontos, para um zoom de 100%, da borda esquerda da planilha até a borda esquerda do intervalo.
linkedDataTypeState	Representa o estado do tipo de dados de cada célula.
numberFormat	Representa o código de formato de número do Excel para determinado intervalo. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número.
numberFormatCategories	Representa a categoria do formato de número de cada célula.
numberFormatLocal	Representa o código de formato de número do Excel para determinado intervalo, com base nas configurações de idioma do usuário. O Excel não executa nenhuma coerção de idioma ou formato 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.
rowCount	Retorna o número total de linhas no intervalo.
rowHidden	Representa se todas as linhas no intervalo atual estão ocultas. O valor é `true` quando todas as linhas em um intervalo estão ocultas. O valor é `false` quando nenhuma linha no intervalo está oculta. O valor é `null` quando algumas linhas em um intervalo estão ocultas e outras linhas no mesmo intervalo não estão ocultas.
rowIndex	Representa o número de linhas da primeira célula no intervalo. Indexados com zero.
savedAsArray	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 forem salvas como uma fórmula de matriz. Retorna `null` se algumas células seriam salvas como uma fórmula de matriz e outras não.
sort	Representa a classificação de intervalo do intervalo atual.
style	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 estilos internos, uma cadeia de caracteres que representa um valor na enumeração `BuiltInStyle` será retornada.
text	Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição do sinal de número (#) que ocorre na interface do usuário do Excel não afetará o valor de texto retornado pela API.
top	Retorna a distância em pontos, para um zoom de 100%, da borda superior da planilha até a borda superior do intervalo.
values	Representa os valores brutos do intervalo especificado. Os dados retornados podem ser uma cadeia de caracteres, um número ou um booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor retornado começar com um sinal de mais ("+"), sinal de subtração ("-") ou sinal de igual ("="), o Excel interpretará esse valor como uma fórmula. Cadeias de caracteres em forma de localidade (como a data "19-8-2025" em nl-NL ou fr-FR, formato DD-MM-AAAA) são armazenadas como texto em vez de datas. Para garantir que as datas sejam armazenadas como datas, use uma API com reconhecimento de localidade como `formulasLocal` ou use um formato neutro de localidade como ISO (AAAA-MM-DD) ou uma data numérica serial.
valuesAsJson	Uma representação JSON dos valores nas células desse intervalo. Ao contrário do `Range.values`, `Range.valuesAsJson` oferece suporte a todos os tipos de dados que podem estar em uma célula. Os exemplos incluem valores numéricos formatados e imagens da Web, além dos valores booleanos padrão, numéricos e de cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade en-US. Para recuperar dados na localidade de exibição do usuário, use `Range.valuesAsJsonLocal`.
valuesAsJsonLocal	Uma representação JSON dos valores nas células desse intervalo. Ao contrário do `Range.values`, `Range.valuesAsJsonLocal` oferece suporte a todos os tipos de dados que podem estar em uma célula. Os exemplos incluem valores numéricos formatados e imagens da Web, além dos valores booleanos padrão, numéricos e de cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade de exibição do usuário. Para recuperar dados independentes da localidade, use `Range.valuesAsJson`.
valueTypes	Especifica o tipo de dados em cada célula.
width	Retorna a distância em pontos, para um zoom de 100%, da borda esquerda do intervalo até a borda direita do intervalo.
worksheet	A planilha que contém o intervalo atual.

Métodos

autoFill(destinationRange, autoFillType)	Preenche um intervalo do intervalo atual para o intervalo de destino usando a lógica de AutoPreenchimento especificada. O intervalo de destino pode ser `null` ou pode estender o intervalo de origem horizontal ou verticalmente. Intervalos descontíguos não são suportados. Para obter mais informações, consulte Usar o AutoPreenchimento e o Preenchimento Relâmpago.
autoFill(destinationRange, autoFillType)	Preenche um intervalo do intervalo atual para o intervalo de destino usando a lógica de AutoPreenchimento especificada. O intervalo de destino pode ser `null` ou pode estender o intervalo de origem horizontal ou verticalmente. Intervalos descontíguos não são suportados. Para obter mais informações, consulte Usar o AutoPreenchimento e o Preenchimento Relâmpago.
calculate()	Calcula um intervalo de células em uma planilha.
clear(applyTo)	Limpe os valores e a formatação do intervalo, como preenchimento e borda.
clear(applyTo)	Limpe os valores e a formatação do intervalo, como preenchimento e borda.
clearOrResetContents()	Limpa os valores das células no intervalo, com consideração especial dada às células que contêm controles. Se o intervalo contiver apenas valores em branco e controles definidos com seu valor padrão, os valores e a formatação de controle serão removidos. Caso contrário, isso definirá as células com controles para seu valor padrão e limpará os valores das outras células no intervalo.
convertDataTypeToText()	Converte as células do intervalo com tipos de dados em texto.
convertToLinkedDataType(serviceID, languageCulture)	Converte as células do intervalo em tipos de dados vinculados na planilha.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copia os dados da célula ou a formatação do intervalo de origem ou `RangeAreas` para o intervalo atual. O intervalo de destino pode ter um tamanho diferente do intervalo de origem ou `RangeAreas`. O destino será expandido automaticamente se for menor que a origem. Observação: Como a funcionalidade de cópia na interface do usuário do Excel, se o intervalo de destino for um múltiplo exato maior que o intervalo de origem em linhas ou colunas, o conteúdo de origem será replicado várias vezes. Por exemplo, uma cópia de intervalo 2x2 para um intervalo 2x6 resultará em 3 cópias do intervalo 2x2 original.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copia os dados da célula ou a formatação do intervalo de origem ou `RangeAreas` para o intervalo atual. O intervalo de destino pode ter um tamanho diferente do intervalo de origem ou `RangeAreas`. O destino será expandido automaticamente se for menor que a origem. Observação: Como a funcionalidade de cópia na interface do usuário do Excel, se o intervalo de destino for um múltiplo exato maior que o intervalo de origem em linhas ou colunas, o conteúdo de origem será replicado várias vezes. Por exemplo, uma cópia de intervalo 2x2 para um intervalo 2x6 resultará em 3 cópias do intervalo 2x2 original.
delete(shift)	Exclui as células associadas ao intervalo.
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 do 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.
findOrNullObject(text, criteria)	Localiza certa cadeia de caracteres com base em critérios especificados. Se o intervalo atual for maior do 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 correspondências, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
flashFill()	Faz um preenchimento relâmpago para o intervalo atual. O Preenchimento Relâmpago preenche automaticamente os dados quando detecta um padrão, portanto, o intervalo deve ser um intervalo de uma única coluna e ter dados ao seu redor para encontrar um padrão.
getAbsoluteResizedRange(numRows, numColumns)	Obtém um `Range` objeto com a mesma célula superior esquerda que o objeto atual `Range` , mas com o número especificado de linhas e colunas.
getBoundingRect(anotherRange)	Obtém o menor objeto de intervalo que abrange os intervalos determinados. Por exemplo, " `GetBoundingRect` 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 permaneça dentro da grade da planilha. A localização da célula retornada está relacionada à célula superior esquerda do intervalo.
getCellProperties(cellPropertiesLoadOptions)	Retorna uma matriz 2D encapsulando os dados de fonte, preenchimento, bordas, alinhamento e outras propriedades de cada célula.
getColumn(column)	Obtém uma coluna incluída no intervalo.
getColumnProperties(columnPropertiesLoadOptions)	Retorna uma única matriz dimensional encapsulando os dados de fonte, preenchimento, bordas, alinhamento e outras propriedades de cada coluna. Para propriedades que não são consistentes nas células de uma determinada coluna, será retornado null.
getColumnsAfter(count)	Obtém um determinado número de colunas à direita do objeto atual `Range` .
getColumnsBefore(count)	Obtém um determinado número de colunas à esquerda do objeto atual `Range` .
getDependents()	Retorna um `WorkbookRangeAreas` objeto que representa o intervalo que contém todas as células dependentes de um intervalo especificado na mesma planilha ou em várias planilhas. Gera um `ItemNotFound` erro se nenhum dependente for encontrado.
getDirectDependents()	Retorna um `WorkbookRangeAreas` objeto que representa o intervalo que contém todas as células dependentes diretas de um intervalo especificado na mesma planilha ou em várias planilhas. Gera um `ItemNotFound` erro se nenhum dependente for encontrado.
getDirectPrecedents()	Retorna um `WorkbookRangeAreas` objeto que representa o intervalo que contém todas as células de precedente direta de um intervalo especificado na mesma planilha ou em várias planilhas. Gera um `ItemNotFound` erro se nenhum precedente for encontrado.
getDisplayedCellProperties(cellPropertiesLoadOptions)	Retorna uma matriz 2D, encapsulando os dados de exibição para a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades de cada célula. Ao contrário `getCellProperties`de , que mostra apenas propriedades definidas diretamente para a célula, isso retorna propriedades que são exibidas de fontes indiretas, como formatação condicional ou estilos.
getEntireColumn()	Obtém um objeto que representa a coluna inteira do intervalo (por exemplo, se o intervalo atual representa as células "B4:E11", é `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", é `GetEntireRow` um intervalo que representa as linhas "4:11").
getExtendedRange(direction, activeCell)	Retorna um objeto de intervalo que inclui o intervalo atual e até a borda do intervalo, com base na direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Shift+Direção na interface do usuário do Excel no Windows.
getExtendedRange(direction, activeCell)	Retorna um objeto de intervalo que inclui o intervalo atual e até a borda do intervalo, com base na direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Shift+Direção na interface do usuário do Excel no Windows.
getImage()	Renderiza o intervalo como uma imagem PNG codificada em Base64.
getIntersection(anotherRange)	Obtém o objeto de intervalo que representa a interseção retangular dos intervalos determinados.
getIntersectionOrNullObject(anotherRange)	Obtém o objeto de intervalo que representa a interseção retangular dos intervalos determinados. Se nenhuma interseção for encontrada, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
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".
getMergedAreasOrNullObject()	Retorna um `RangeAreas` objeto que representa as áreas mescladas nesse intervalo. Observe que, se a contagem de áreas mescladas nesse intervalo for maior que 512, esse método não retornará o resultado. Se o `RangeAreas` objeto não existir, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
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õem ao intervalo.
getPrecedents()	Retorna um `WorkbookRangeAreas` objeto que representa o intervalo que contém todas as células precedentes de um intervalo especificado na mesma planilha ou em várias planilhas. Gera um `ItemNotFound` erro se nenhum precedente for encontrado.
getRangeEdge(direction, activeCell)	Retorna um objeto de intervalo que é a célula de borda da região de dados que corresponde à direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Direção na interface do usuário do Excel no Windows.
getRangeEdge(direction, activeCell)	Retorna um objeto de intervalo que é a célula de borda da região de dados que corresponde à direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Direção na interface do usuário do Excel no Windows.
getResizedRange(deltaRows, deltaColumns)	Obtém um `Range` objeto semelhante ao objeto atual `Range` , mas com seu canto inferior direito expandido (ou contraído) por um certo número de linhas e colunas.
getRow(row)	Obtém uma linha contida no intervalo.
getRowProperties(rowPropertiesLoadOptions)	Retorna uma única matriz dimensional encapsulando os dados de fonte, preenchimento, bordas, alinhamento e outras propriedades de cada célula. Para propriedades que não são consistentes em cada célula dentro de uma determinada linha, `null` serão retornados.
getRowsAbove(count)	Obtém um determinado número de linhas acima do objeto atual `Range` .
getRowsBelow(count)	Obtém um determinado número de linhas abaixo do objeto atual `Range` .
getSpecialCells(cellType, cellValueType)	Obtém o `RangeAreas` objeto, compreendendo um ou mais intervalos retangulares, que representa todas as células que correspondem ao tipo e valor especificados. Se nenhuma célula especial for encontrada, um `ItemNotFound` erro será gerado.
getSpecialCells(cellType, cellValueType)	Obtém o `RangeAreas` objeto, compreendendo um ou mais intervalos retangulares, que representa todas as células que correspondem ao tipo e valor especificados. Se nenhuma célula especial for encontrada, um `ItemNotFound` erro será gerado.
getSpecialCellsOrNullObject(cellType, cellValueType)	Obtém o `RangeAreas` objeto, compreendendo um ou mais intervalos, que representa todas as células que correspondem ao tipo e valor especificados. Se nenhuma célula especial for encontrada, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getSpecialCellsOrNullObject(cellType, cellValueType)	Obtém o `RangeAreas` objeto, compreendendo um ou mais intervalos, que representa todas as células que correspondem ao tipo e valor especificados. Se nenhuma célula especial for encontrada, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getSpillingToRange()	Obtém objeto range que contém o intervalo de despejo quando chamado em uma célula âncora. Falha se aplicado a um intervalo com mais de uma célula.
getSpillingToRangeOrNullObject()	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 âncora ou o intervalo de derramamento não puder ser encontrado, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getSpillParent()	Obtém o objeto range que contém a célula âncora para uma célula que recebe o despejo. Falha se aplicado a um intervalo com mais de uma célula.
getSpillParentOrNullObject()	Obtém o objeto de intervalo que contém a célula âncora da célula que está sendo despejada. Se não for uma célula despejada ou mais de uma célula for fornecida, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getSurroundingRegion()	Retorna um `Range` objeto que representa a região ao redor 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.
getUsedRange(valuesOnly)	Retorna o intervalo usado do objeto de intervalo determinado. Se não houver células usadas dentro do intervalo, esta função gerará um `ItemNotFound` erro.
getUsedRangeOrNullObject(valuesOnly)	Retorna o intervalo usado do objeto de intervalo determinado. Se não houver células usadas no intervalo, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getVisibleView()	Representa as linhas visíveis do intervalo atual.
group(groupOption)	Agrupa colunas e linhas para obter uma estrutura de tópicos.
group(groupOption)	Agrupa colunas e linhas para obter uma estrutura de tópicos.
hideGroupDetails(groupOption)	Oculta os detalhes do grupo de linha ou coluna.
hideGroupDetails(groupOption)	Oculta os detalhes do grupo de linha ou coluna.
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 `Range` objeto com espaço em branco.
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 `Range` objeto com espaço em branco.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
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 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. Observação: quando um intervalo é movido para um novo endereço usando essa API, o novo objeto de intervalo deve ser recuperado usando o novo endereço.
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.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
setCellProperties(cellPropertiesData)	Atualizações o intervalo com base em uma matriz 2D de propriedades de célula, encapsulando itens como fonte, preenchimento, bordas e alinhamento.
setColumnProperties(columnPropertiesData)	Atualizações o intervalo com base em uma matriz unidimensional de propriedades de coluna, encapsulando itens como fonte, preenchimento, bordas e alinhamento.
setDirty()	Define um intervalo a ser recalculado quando o próximo recálculo ocorrer.
setRowProperties(rowPropertiesData)	Atualizações o intervalo com base em uma matriz unidimensional de propriedades de linha, encapsulando itens como fonte, preenchimento, bordas e alinhamento.
showCard()	Exibe o cartão para uma célula ativa se ele tiver um conteúdo valioso.
showGroupDetails(groupOption)	Mostra os detalhes do grupo de linhas ou colunas.
showGroupDetails(groupOption)	Mostra os detalhes do grupo de linhas ou colunas.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`, por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o objeto original `Excel.Range` é um objeto de API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Excel.Interfaces.RangeData`) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre `.sync` chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez.
ungroup(groupOption)	Desagrupa colunas e linhas para criar uma estrutura de tópicos.
ungroup(groupOption)	Desagrupa colunas e linhas para criar uma estrutura de tópicos.
unmerge()	Desfaz a mesclagem das células do intervalo em células separadas.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar `context.sync()` antes que a liberação de memória entre em vigor.

address

Especifica a referência de intervalo no estilo A1. O valor do endereço contém a referência de planilha (por exemplo, "Planilha1! A1:B4").

readonly address: string;

Valor da propriedade

string

Comentários

[Conjunto de apis: ExcelApi 1.1]

addressLocal

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

readonly addressLocal: string;

Valor da propriedade

string

Comentários

[Conjunto de apis: ExcelApi 1.1]

cellCount

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).

readonly cellCount: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.1]

columnCount

Especifica o número total de colunas no intervalo.

readonly columnCount: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.1]

columnHidden

Representa se todas as colunas no intervalo atual estão ocultas. Valor é true quando todas as colunas em um intervalo estão ocultas. Valor é false quando nenhuma coluna no intervalo está oculta. Valor é null quando algumas colunas em um intervalo estão ocultas e outras colunas no mesmo intervalo não estão ocultas.

columnHidden: boolean;

Valor da propriedade

boolean

Comentários

[Conjunto de apis: ExcelApi 1.2]

columnIndex

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

readonly columnIndex: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.1]

conditionalFormats

A coleção dessa ConditionalFormats interseção a cordilheira.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valor da propriedade

Excel.ConditionalFormatCollection

Comentários

[Conjunto de apis: ExcelApi 1.6]

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

control

Acessa o controle de célula aplicado a esse intervalo. Se o intervalo tiver vários controles de célula, isso retornará EmptyCellControl.

control: CellControl;

Valor da propriedade

Excel.CellControl

Comentários

[Conjunto de apis: ExcelApi 1.18]

dataValidation

Retorna um objeto de validação de dados.

readonly dataValidation: Excel.DataValidation;

Valor da propriedade

Excel.DataValidation

Comentários

[Conjunto de apis: ExcelApi 1.8]

format

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

readonly format: Excel.RangeFormat;

Valor da propriedade

Excel.RangeFormat

Comentários

[Conjunto de apis: ExcelApi 1.1]

formulas

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

formulas: any[][];

Valor da propriedade

any[][]

Comentários

[Conjunto de apis: ExcelApi 1.1]

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 fórmula, seu valor será retornado em vez disso.

formulasLocal: any[][];

Valor da propriedade

any[][]

Comentários

[Conjunto de apis: ExcelApi 1.1]

formulasR1C1

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

formulasR1C1: any[][];

Valor da propriedade

any[][]

Comentários

[Conjunto de apis: ExcelApi 1.2]

hasSpill

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

readonly hasSpill: boolean;

Valor da propriedade

boolean

Comentários

[Conjunto de apis: ExcelApi 1.12]

height

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

readonly height: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.10]

hidden

Representa se todas as células no intervalo atual estão ocultas. Valor é true quando todas as células em um intervalo estão ocultas. Valor é false quando nenhuma célula do intervalo está oculta. O valor é null quando algumas células de um intervalo estão ocultas e outras células do mesmo intervalo não estão ocultas.

readonly hidden: boolean;

Valor da propriedade

boolean

Comentários

[Conjunto de apis: ExcelApi 1.2]

hyperlink

Representa o hiperlink para o intervalo atual.

hyperlink: Excel.RangeHyperlink;

Valor da propriedade

Excel.RangeHyperlink

Comentários

[Conjunto de apis: ExcelApi 1.7]

isEntireColumn

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

readonly isEntireColumn: boolean;

Valor da propriedade

boolean

Comentários

[Conjunto de apis: ExcelApi 1.7]

isEntireRow

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

readonly isEntireRow: boolean;

Valor da propriedade

boolean

Comentários

[Conjunto de apis: ExcelApi 1.7]

left

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

readonly left: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.10]

linkedDataTypeState

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

readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];

Valor da propriedade

Excel.LinkedDataTypeState[][]

Comentários

[Conjunto de apis: ExcelApi 1.9]

numberFormat

Representa o código de formato de número do Excel para determinado intervalo. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número.

numberFormat: any[][];

Valor da propriedade

any[][]

Comentários

[Conjunto de apis: ExcelApi 1.1]

numberFormatCategories

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

readonly numberFormatCategories: Excel.NumberFormatCategory[][];

Valor da propriedade

Excel.NumberFormatCategory[][]

Comentários

[Conjunto de apis: ExcelApi 1.12]

numberFormatLocal

Representa o código de formato de número do Excel para determinado intervalo, com base nas configurações de idioma do usuário. O Excel não executa nenhuma coerção de idioma ou formato 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.

numberFormatLocal: any[][];

Valor da propriedade

any[][]

Comentários

[Conjunto de apis: ExcelApi 1.7]

rowCount

Retorna o número total de linhas no intervalo.

readonly rowCount: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.1]

rowHidden

Representa se todas as linhas no intervalo atual estão ocultas. O valor é true quando todas as linhas em um intervalo estão ocultas. O valor é false quando nenhuma linha no intervalo está oculta. O valor é null quando algumas linhas em um intervalo estão ocultas e outras linhas no mesmo intervalo não estão ocultas.

rowHidden: boolean;

Valor da propriedade

boolean

Comentários

[Conjunto de apis: ExcelApi 1.2]

rowIndex

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

readonly rowIndex: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.1]

savedAsArray

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 forem salvas como uma fórmula de matriz. Retorna null se algumas células seriam salvas como uma fórmula de matriz e outras não.

readonly savedAsArray: boolean;

Valor da propriedade

boolean

Comentários

[Conjunto de apis: ExcelApi 1.12]

sort

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

readonly sort: Excel.RangeSort;

Valor da propriedade

Excel.RangeSort

Comentários

[Conjunto de apis: ExcelApi 1.2]

style

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 estilos internos, uma cadeia de caracteres que representa um valor na enumeração BuiltInStyle será retornada.

style: string;

Valor da propriedade

string

Comentários

[Conjunto de apis: ExcelApi 1.7]

text

Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição do sinal de número (#) que ocorre na interface do usuário do Excel não afetará o valor de texto retornado pela API.

readonly text: string[][];

Valor da propriedade

string[][]

Comentários

[Conjunto de apis: ExcelApi 1.1]

top

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

readonly top: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.10]

values

Representa os valores brutos do intervalo especificado. Os dados retornados podem ser uma cadeia de caracteres, um número ou um booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor retornado começar com um sinal de mais ("+"), sinal de subtração ("-") ou sinal de igual ("="), o Excel interpretará esse valor como uma fórmula. Cadeias de caracteres em forma de localidade (como a data "19-8-2025" em nl-NL ou fr-FR, formato DD-MM-AAAA) são armazenadas como texto em vez de datas. Para garantir que as datas sejam armazenadas como datas, use uma API com reconhecimento de localidade como formulasLocal ou use um formato neutro de localidade como ISO (AAAA-MM-DD) ou uma data numérica serial.

values: any[][];

Valor da propriedade

any[][]

Comentários

[Conjunto de apis: ExcelApi 1.1]

valuesAsJson

Uma representação JSON dos valores nas células desse intervalo. Ao contrário do Range.values, Range.valuesAsJson oferece suporte a todos os tipos de dados que podem estar em uma célula. Os exemplos incluem valores numéricos formatados e imagens da Web, além dos valores booleanos padrão, numéricos e de cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade en-US. Para recuperar dados na localidade de exibição do usuário, use Range.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Valor da propriedade

Excel.CellValue[][]

Comentários

[Conjunto de apis: ExcelApi 1.16]

valuesAsJsonLocal

Uma representação JSON dos valores nas células desse intervalo. Ao contrário do Range.values, Range.valuesAsJsonLocal oferece suporte a todos os tipos de dados que podem estar em uma célula. Os exemplos incluem valores numéricos formatados e imagens da Web, além dos valores booleanos padrão, numéricos e de cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade de exibição do usuário. Para recuperar dados independentes da localidade, use Range.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Valor da propriedade

Excel.CellValue[][]

Comentários

[Conjunto de apis: ExcelApi 1.16]

valueTypes

Especifica o tipo de dados em cada célula.

readonly valueTypes: Excel.RangeValueType[][];

Valor da propriedade

Excel.RangeValueType[][]

Comentários

[Conjunto de apis: ExcelApi 1.1]

width

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

readonly width: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.10]

worksheet

A planilha que contém o intervalo atual.

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Excel.Worksheet

Comentários

[Conjunto de apis: ExcelApi 1.1]

autoFill(destinationRange, autoFillType)

Preenche um intervalo do intervalo atual para o intervalo de destino usando a lógica de AutoPreenchimento especificada. O intervalo de destino pode ser null ou pode estender o intervalo de origem horizontal ou verticalmente. Intervalos descontíguos não são suportados.

Para obter mais informações, consulte Usar o AutoPreenchimento e o Preenchimento Relâmpago.

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

Parâmetros

destinationRange: Excel.Range | string

O intervalo de destino a ser preenchido automaticamente. Se o intervalo de destino for null, os dados serão preenchidos com base nas células ao redor (que é o comportamento ao clicar duas vezes na alça de preenchimento de intervalo da IU).

autoFillType: Excel.AutoFillType

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9, ExcelApi Preview para null destinationRange]

autoFill(destinationRange, autoFillType)

Preenche um intervalo do intervalo atual para o intervalo de destino usando a lógica de AutoPreenchimento especificada. O intervalo de destino pode ser null ou pode estender o intervalo de origem horizontal ou verticalmente. Intervalos descontíguos não são suportados.

Para obter mais informações, consulte Usar o AutoPreenchimento e o Preenchimento Relâmpago.

autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;

Parâmetros

destinationRange: Excel.Range | string

O intervalo de destino a ser preenchido automaticamente. Se o intervalo de destino for null, os dados serão preenchidos com base nas células ao redor (que é o comportamento ao clicar duas vezes na alça de preenchimento de intervalo da IU).

autoFillType: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9, ExcelApi Preview para null destinationRange]

calculate()

Calcula um intervalo de células em uma planilha.

calculate(): void;

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.6]

clear(applyTo)

Limpe os valores e a formatação do intervalo, como preenchimento e borda.

clear(applyTo?: Excel.ClearApplyTo): void;

Parâmetros

applyTo: Excel.ClearApplyTo

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.1]

clear(applyTo)

Limpe os valores e a formatação do intervalo, como preenchimento e borda.

clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

Parâmetros

applyTo: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Parâmetros

serviceID: number

A ID do serviço que será usada para consultar os dados.

languageCulture: string

Cultura linguística para consultar o serviço.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia os dados da célula ou a formatação do intervalo de origem ou RangeAreas para o intervalo atual. O intervalo de destino pode ter um tamanho diferente do intervalo de origem ou RangeAreas. O destino será expandido automaticamente se for menor que a origem. Observação: Como a funcionalidade de cópia na interface do usuário do Excel, se o intervalo de destino for um múltiplo exato maior que o intervalo de origem em linhas ou colunas, o conteúdo de origem será replicado várias vezes. Por exemplo, uma cópia de intervalo 2x2 para um intervalo 2x6 resultará em 3 cópias do intervalo 2x2 original.

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

Parâmetros

sourceRange: Excel.Range | Excel.RangeAreas | string

O intervalo de origem ou RangeAreas do qual copiar. Quando a origem RangeAreas tem vários intervalos, seu formulário deve ser capaz de ser criado removendo linhas ou colunas inteiras de um intervalo retangular.

copyType: Excel.RangeCopyType

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

skipBlanks: boolean

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

transpose: boolean

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copia os dados da célula ou a formatação do intervalo de origem ou RangeAreas para o intervalo atual. O intervalo de destino pode ter um tamanho diferente do intervalo de origem ou RangeAreas. O destino será expandido automaticamente se for menor que a origem. Observação: Como a funcionalidade de cópia na interface do usuário do Excel, se o intervalo de destino for um múltiplo exato maior que o intervalo de origem em linhas ou colunas, o conteúdo de origem será replicado várias vezes. Por exemplo, uma cópia de intervalo 2x2 para um intervalo 2x6 resultará em 3 cópias do intervalo 2x2 original.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, transpose?: boolean): void;

Parâmetros

sourceRange: Excel.Range | Excel.RangeAreas | string

O intervalo de origem ou RangeAreas do qual copiar. Quando a origem RangeAreas tem vários intervalos, seu formulário deve ser capaz de ser criado removendo linhas ou colunas inteiras de um intervalo retangular.

copyType: "All" | "Formulas" | "Values" | "Formats" | "Link"

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

skipBlanks: boolean

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

transpose: boolean

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9]

delete(shift)

Exclui as células associadas ao intervalo.

delete(shift: Excel.DeleteShiftDirection): void;

Parâmetros

shift: Excel.DeleteShiftDirection

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.1]

delete(shift)

Exclui as células associadas ao intervalo.

delete(shift: "Up" | "Left"): void;

Parâmetros

shift: "Up" | "Left"

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.1]

find(text, criteria)

Localiza certa cadeia de caracteres com base em critérios especificados. Se o intervalo atual for maior do 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.

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

Parâmetros

text: string

A cadeia de caracteres a localizar.

criteria: Excel.SearchCriteria

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

Retornos

Excel.Range

O Range objeto que representa a primeira célula que contém um valor que corresponda ao texto e aos critérios de pesquisa.

Comentários

[Conjunto de apis: ExcelApi 1.9]

findOrNullObject(text, criteria)

Localiza certa cadeia de caracteres com base em critérios especificados. Se o intervalo atual for maior do 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 correspondências, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Parâmetros

text: string

A cadeia de caracteres a localizar.

criteria: Excel.SearchCriteria

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

Retornos

Excel.Range

O Range que correspondeu aos critérios de pesquisa.

Comentários

[Conjunto de apis: ExcelApi 1.9]

flashFill()

Faz um preenchimento relâmpago para o intervalo atual. O Preenchimento Relâmpago preenche automaticamente os dados quando detecta um padrão, portanto, o intervalo deve ser um intervalo de uma única coluna e ter dados ao seu redor para encontrar um padrão.

flashFill(): void;

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9]

getAbsoluteResizedRange(numRows, numColumns)

Obtém um Range objeto com a mesma célula superior esquerda que o objeto atual Range , mas com o número especificado de linhas e colunas.

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

Parâmetros

numRows: number

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

numColumns: number

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

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.7]

getBoundingRect(anotherRange)

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

getBoundingRect(anotherRange: Range | string): Excel.Range;

Parâmetros

anotherRange: Excel.Range | string

O objeto de intervalo, endereço ou nome de intervalo.

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

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 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): Excel.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

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

getCellProperties(cellPropertiesLoadOptions)

Retorna uma matriz 2D encapsulando os dados de fonte, preenchimento, bordas, alinhamento e outras propriedades de cada célula.

getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Parâmetros

cellPropertiesLoadOptions: Excel.CellPropertiesLoadOptions

Um objeto que representa quais propriedades da célula carregar.

Retornos

OfficeExtension.ClientResult<Excel.CellProperties[][]>

Uma matriz 2D em que cada item representa as propriedades solicitadas da célula correspondente.

Comentários

[Conjunto de apis: ExcelApi 1.9]

getColumn(column)

Obtém uma coluna incluída no intervalo.

getColumn(column: number): Excel.Range;

Parâmetros

column: number

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

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

getColumnProperties(columnPropertiesLoadOptions)

Retorna uma única matriz dimensional encapsulando os dados de fonte, preenchimento, bordas, alinhamento e outras propriedades de cada coluna. Para propriedades que não são consistentes nas células de uma determinada coluna, será retornado null.

getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions): OfficeExtension.ClientResult<ColumnProperties[]>;

Parâmetros

columnPropertiesLoadOptions: Excel.ColumnPropertiesLoadOptions

Um objeto que representa quais propriedades de coluna carregar.

Retornos

OfficeExtension.ClientResult<Excel.ColumnProperties[]>

Uma matriz em que cada item representa as propriedades solicitadas da coluna correspondente.

Comentários

[Conjunto de apis: ExcelApi 1.9]

getColumnsAfter(count)

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

getColumnsAfter(count?: number): Excel.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

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.2]

getColumnsBefore(count)

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

getColumnsBefore(count?: number): Excel.Range;

Parâmetros

count: number

getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Parâmetros

cellPropertiesLoadOptions: Excel.CellPropertiesLoadOptions

Um objeto que representa quais propriedades da célula carregar.

Retornos

OfficeExtension.ClientResult<Excel.CellProperties[][]>

Uma matriz 2D em que cada item representa as propriedades de exibição solicitadas da célula correspondente.

Comentários

[Conjunto de apis: ExcelApi 1.19]

getEntireColumn()

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

getEntireColumn(): Excel.Range;

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

getEntireRow()

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

getEntireRow(): Excel.Range;

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

getExtendedRange(direction, activeCell)

Retorna um objeto de intervalo que inclui o intervalo atual e até a borda do intervalo, com base na direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Shift+Direção na interface do usuário do Excel no Windows.

getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Parâmetros

direction: Excel.KeyboardDirection

A direção da célula ativa.

activeCell: Excel.Range | string

A célula ativa nesse intervalo. Por padrão, a célula ativa é a célula superior esquerda do intervalo. Um erro será gerado se a célula ativa não estiver nesse intervalo.

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.13]

getExtendedRange(direction, activeCell)

Retorna um objeto de intervalo que inclui o intervalo atual e até a borda do intervalo, com base na direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Shift+Direção na interface do usuário do Excel no Windows.

getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Parâmetros

direction: "Left" | "Right" | "Up" | "Down"

A direção da célula ativa.

activeCell: Excel.Range | string

A célula ativa nesse intervalo. Por padrão, a célula ativa é a célula superior esquerda do intervalo. Um erro será gerado se a célula ativa não estiver nesse intervalo.

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.13]

getImage()

Renderiza o intervalo como uma imagem PNG codificada em Base64.

getImage(): OfficeExtension.ClientResult<string>;

Retornos

OfficeExtension.ClientResult<string>

Comentários

[Conjunto de apis: ExcelApi 1.7]

getIntersection(anotherRange)

Obtém o objeto de intervalo que representa a interseção retangular dos intervalos determinados.

getIntersection(anotherRange: Range | string): Excel.Range;

Parâmetros

anotherRange: Excel.Range | string

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

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

getIntersectionOrNullObject(anotherRange)

Obtém o objeto de intervalo que representa a interseção retangular dos intervalos determinados. Se nenhuma interseção for encontrada, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range;

Parâmetros

anotherRange: Excel.Range | string

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

Parâmetros

rowOffset: number

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

columnOffset: number

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

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

getPivotTables(fullyContained)

Obtém uma coleção com escopo de Tabelas Dinâmicas que se sobrepõem ao intervalo.

getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;

Parâmetros

fullyContained: boolean

Se true, retorna somente Tabelas Dinâmicas que estão totalmente contidas dentro dos limites do intervalo. O valor padrão é false.

Retornos

Excel.PivotTableScopedCollection

Comentários

[Conjunto de apis: ExcelApi 1.12]

getPrecedents()

Retorna um WorkbookRangeAreas objeto que representa o intervalo que contém todas as células precedentes de um intervalo especificado na mesma planilha ou em várias planilhas. Gera um ItemNotFound erro se nenhum precedente for encontrado.

getPrecedents(): Excel.WorkbookRangeAreas;

Retornos

Excel.WorkbookRangeAreas

Comentários

[Conjunto de apis: ExcelApi 1.14]

getRangeEdge(direction, activeCell)

Retorna um objeto de intervalo que é a célula de borda da região de dados que corresponde à direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Direção na interface do usuário do Excel no Windows.

getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Parâmetros

direction: Excel.KeyboardDirection

A direção da célula ativa.

activeCell: Excel.Range | string

A célula ativa nesse intervalo. Por padrão, a célula ativa é a célula superior esquerda do intervalo. Um erro será gerado se a célula ativa não estiver nesse intervalo.

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.13]

getRangeEdge(direction, activeCell)

Retorna um objeto de intervalo que é a célula de borda da região de dados que corresponde à direção fornecida. Isso corresponde ao comportamento da tecla Ctrl+Direção na interface do usuário do Excel no Windows.

getRangeEdge(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Parâmetros

direction: "Left" | "Right" | "Up" | "Down"

A direção da célula ativa.

activeCell: Excel.Range | string

A célula ativa nesse intervalo. Por padrão, a célula ativa é a célula superior esquerda do intervalo. Um erro será gerado se a célula ativa não estiver nesse intervalo.

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.13]

getResizedRange(deltaRows, deltaColumns)

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

getResizedRange(deltaRows: number, deltaColumns: number): Excel.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

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.2]

getRow(row)

Obtém uma linha contida no intervalo.

getRow(row: number): Excel.Range;

Parâmetros

row: number

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

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

getRowProperties(rowPropertiesLoadOptions)

Retorna uma única matriz dimensional encapsulando os dados de fonte, preenchimento, bordas, alinhamento e outras propriedades de cada célula. Para propriedades que não são consistentes em cada célula dentro de uma determinada linha, null serão retornados.

getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): OfficeExtension.ClientResult<RowProperties[]>;

Parâmetros

rowPropertiesLoadOptions: Excel.RowPropertiesLoadOptions

Um objeto que representa quais propriedades de linha carregar.

Retornos

OfficeExtension.ClientResult<Excel.RowProperties[]>

Uma matriz em que cada item representa as propriedades solicitadas da linha correspondente.

Comentários

[Conjunto de apis: ExcelApi 1.9]

getRowsAbove(count)

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

getRowsAbove(count?: number): Excel.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

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.2]

getRowsBelow(count)

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

getRowsBelow(count?: number): Excel.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

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.2]

getSpecialCells(cellType, cellValueType)

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

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

Parâmetros

cellType: Excel.SpecialCellType

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

cellValueType: Excel.SpecialCellValueType

Se cellType for ou constantsformulas, esse argumento será usado para determinar quais tipos de células serão incluídos no resultado. Esses valores podem ser combinados para retornar mais de um tipo. O padrão é selecionar todas as constantes ou as fórmulas, independente do tipo.

Retornos

Excel.RangeAreas

Comentários

[Conjunto de apis: ExcelApi 1.9]

getSpecialCells(cellType, cellValueType)

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

getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parâmetros

cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

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

cellValueType: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Se cellType for ou constantsformulas, esse argumento será usado para determinar quais tipos de células serão incluídos no resultado. Esses valores podem ser combinados para retornar mais de um tipo. O padrão é selecionar todas as constantes ou as fórmulas, independente do tipo.

Retornos

Excel.RangeAreas

Comentários

[Conjunto de apis: ExcelApi 1.9]

getSpecialCellsOrNullObject(cellType, cellValueType)

Obtém o RangeAreas objeto, compreendendo um ou mais intervalos, que representa todas as células que correspondem ao tipo e valor especificados. Se nenhuma célula especial for encontrada, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parâmetros

cellType: Excel.SpecialCellType

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

cellValueType: Excel.SpecialCellValueType

Se cellType for ou constantsformulas, esse argumento será usado para determinar quais tipos de células serão incluídos no resultado. Esses valores podem ser combinados para retornar mais de um tipo. O padrão é selecionar todas as constantes ou as fórmulas, independente do tipo.

Retornos

Excel.RangeAreas

Comentários

[Conjunto de apis: ExcelApi 1.9]

getSpecialCellsOrNullObject(cellType, cellValueType)

Obtém o RangeAreas objeto, compreendendo um ou mais intervalos, que representa todas as células que correspondem ao tipo e valor especificados. Se nenhuma célula especial for encontrada, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parâmetros

cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

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

cellValueType: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Parâmetros

fullyContained: boolean

Se true, retorna somente tabelas que estão totalmente contidas dentro dos limites do intervalo. O valor padrão é false.

Retornos

Excel.TableScopedCollection

Comentários

[Conjunto de apis: ExcelApi 1.9]

getUsedRange(valuesOnly)

Retorna o intervalo usado do objeto de intervalo determinado. Se não houver células usadas dentro do intervalo, esta função gerará um ItemNotFound erro.

getUsedRange(valuesOnly?: boolean): Excel.Range;

Parâmetros

valuesOnly: boolean

Considera apenas as células com valores como células usadas. [Conjunto de apis: ExcelApi 1.2]

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

getUsedRangeOrNullObject(valuesOnly)

Retorna o intervalo usado do objeto de intervalo determinado. Se não houver células usadas no intervalo, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Parâmetros

valuesOnly: boolean

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

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.4]

getVisibleView()

Representa as linhas visíveis do intervalo atual.

getVisibleView(): Excel.RangeView;

Retornos

Excel.RangeView

Comentários

[Conjunto de apis: ExcelApi 1.3]

group(groupOption)

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

group(groupOption: Excel.GroupOption): void;

Parâmetros

groupOption: Excel.GroupOption

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.10]

group(groupOption)

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

group(groupOption: "ByRows" | "ByColumns"): void;

Parâmetros

groupOption: "ByRows" | "ByColumns"

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.10]

hideGroupDetails(groupOption)

Oculta os detalhes do grupo de linha ou coluna.

hideGroupDetails(groupOption: Excel.GroupOption): void;

Parâmetros

groupOption: Excel.GroupOption

Especifica se os detalhes de linhas ou colunas agrupadas devem ser ocultados.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.10]

hideGroupDetails(groupOption)

Oculta os detalhes do grupo de linha ou coluna.

hideGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Parâmetros

groupOption: "ByRows" | "ByColumns"

Especifica se os detalhes de linhas ou colunas agrupadas devem ser ocultados.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.10]

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 Range objeto com espaço em branco.

insert(shift: Excel.InsertShiftDirection): Excel.Range;

Parâmetros

shift: Excel.InsertShiftDirection

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

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

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 Range objeto com espaço em branco.

insert(shift: "Down" | "Right"): Excel.Range;

Parâmetros

shift: "Down" | "Right"

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

Retornos

Excel.Range

Comentários

[Conjunto de apis: ExcelApi 1.1]

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range;

Parâmetros

options: Excel.Interfaces.RangeLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Excel.Range

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Excel.Range;

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

Excel.Range

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Range;

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.Range

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 cada linha do intervalo especificado como células mescladas separadas. O valor padrão é false.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.2]

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 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. Observação: quando um intervalo é movido para um novo endereço usando essa API, o novo objeto de intervalo deve ser recuperado usando o novo endereço.

moveTo(destinationRange: Range | string): void;

Parâmetros

destinationRange: Excel.Range | string

destinationRange Especifica o intervalo para o qual as informações nesse intervalo serão movidas.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.11]

removeDuplicates(columns, includesHeader)

Remove valores duplicados do intervalo especificado pelas colunas.

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

Parâmetros

columns: number[]

As colunas dentro do intervalo que podem conter duplicatas. Pelo menos uma coluna precisa ser especificada. Indexados com zero.

includesHeader: boolean

Verdadeiro se os dados de entrada contiverem cabeçalho. O padrão é false.

Retornos

Excel.RemoveDuplicatesResult

O objeto resultante que contém o número de linhas removidas e o número de linhas exclusivas restantes.

Comentários

[Conjunto de apis: ExcelApi 1.9]

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: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Parâmetros

text: string

Cadeia de caracteres a localizar.

replacement: string

A cadeia de caracteres que substitui a cadeia de caracteres original.

criteria: Excel.ReplaceCriteria

Critérios de substituição adicionais.

Retornos

OfficeExtension.ClientResult<number>

O número de substituições realizadas.

Comentários

[Conjunto de apis: ExcelApi 1.9]

select()

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

select(): void;

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.1]

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Excel.Interfaces.RangeUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.Range): void;

Parâmetros

properties: Excel.Range

Retornos

void

setCellProperties(cellPropertiesData)

Atualizações o intervalo com base em uma matriz 2D de propriedades de célula, encapsulando itens como fonte, preenchimento, bordas e alinhamento.

setCellProperties(cellPropertiesData: SettableCellProperties[][]): void;

Parâmetros

cellPropertiesData: Excel.SettableCellProperties[][]

Uma matriz 2D que representa quais propriedades definir em cada célula.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9]

setColumnProperties(columnPropertiesData)

Atualizações o intervalo com base em uma matriz unidimensional de propriedades de coluna, encapsulando itens como fonte, preenchimento, bordas e alinhamento.

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

Parâmetros

columnPropertiesData: Excel.SettableColumnProperties[]

Uma matriz que representa quais propriedades definir em cada coluna.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9]

setDirty()

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

setDirty(): void;

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9]

setRowProperties(rowPropertiesData)

Atualizações o intervalo com base em uma matriz unidimensional de propriedades de linha, encapsulando itens como fonte, preenchimento, bordas e alinhamento.

setRowProperties(rowPropertiesData: SettableRowProperties[]): void;

Parâmetros

rowPropertiesData: Excel.SettableRowProperties[]

Uma matriz que representa quais propriedades definir em cada linha.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.9]

showCard()

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

showCard(): void;

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.7]

showGroupDetails(groupOption)

Mostra os detalhes do grupo de linhas ou colunas.

showGroupDetails(groupOption: Excel.GroupOption): void;

Parâmetros

groupOption: Excel.GroupOption

Especifica se os detalhes de linhas ou colunas agrupadas devem ser mostradas.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.10]

showGroupDetails(groupOption)

Mostra os detalhes do grupo de linhas ou colunas.

showGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Parâmetros

groupOption: "ByRows" | "ByColumns"

Especifica se os detalhes de linhas ou colunas agrupadas devem ser mostradas.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.10]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Range é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.RangeData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.RangeData;

Retornos

Excel.Interfaces.RangeData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez.

track(): Excel.Range;

Retornos

Excel.Range

ungroup(groupOption)

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

ungroup(groupOption: Excel.GroupOption): void;

Parâmetros

groupOption: Excel.GroupOption

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.10]

ungroup(groupOption)

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

ungroup(groupOption: "ByRows" | "ByColumns"): void;

Parâmetros

groupOption: "ByRows" | "ByColumns"

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

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.10]

unmerge()

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

unmerge(): void;

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.2]

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Excel.Range;

Retornos

Excel.Range

Comentários

Propriedades

Métodos

Detalhes da propriedade

address

Valor da propriedade

Comentários

addressLocal

Valor da propriedade

Comentários

cellCount

Valor da propriedade

Comentários

columnCount

Valor da propriedade

Comentários

columnHidden

Valor da propriedade

Comentários

columnIndex

Valor da propriedade

Comentários

conditionalFormats

Valor da propriedade

Comentários

context

Valor da propriedade

control

Valor da propriedade

Comentários

dataValidation

Valor da propriedade

Comentários

format

Valor da propriedade

Comentários

formulas

Valor da propriedade

Comentários

formulasLocal

Valor da propriedade

Comentários

formulasR1C1

Valor da propriedade

Comentários

hasSpill

Valor da propriedade

Comentários

height

Valor da propriedade

Comentários

hidden

Valor da propriedade

Comentários

hyperlink

Valor da propriedade

Comentários

isEntireColumn

Valor da propriedade

Comentários

isEntireRow

Valor da propriedade

Comentários

left

Valor da propriedade

Comentários

linkedDataTypeState

Valor da propriedade

Comentários

numberFormat

Valor da propriedade

Comentários

numberFormatCategories

Valor da propriedade

Comentários

numberFormatLocal

Valor da propriedade

Comentários

rowCount