Excel.Interfaces.RangeCollectionLoadOptions interface

Propriedades

$all

Especificar $all as opções de carga carrega todas as propriedades escalares (comoRange.address ), mas não as propriedades de navegação (como Range.format.fill.color).

address

Para CADA ITEM na coleção: 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

Para EACH ITEM na coleção: Representa a referência de intervalo para o intervalo especificado no idioma do usuário.

cellCount

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: Especifica o número total de colunas no intervalo.

columnHidden

Para EACH ITEM na coleção: 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

Para EACH ITEM na coleção: Especifica o número da coluna da primeira célula no intervalo. Indexados com zero.

dataValidation

Para CADA ITEM na coleção: Retorna um objeto de validação de dados.

format

Para CADA ITEM na coleção: Retorna um objeto de formato, encapsulando a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.

formulas

Para EACH ITEM na coleção: Representa a fórmula em notação no estilo A1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

formulasLocal

Para CADA ITEM na coleção: Representa a fórmula em notação no estilo A1, no idioma do usuário e na localidade de formatação de número. 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

Para EACH ITEM na coleção: Representa a fórmula em notação no estilo R1C1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

hidden

Para EACH ITEM na coleção: 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

Para EACH ITEM na coleção: Representa o hiperlink para o intervalo atual.

isEntireColumn

Para EACH ITEM na coleção: Representa se o intervalo atual é uma coluna inteira.

isEntireRow

Para EACH ITEM na coleção: Representa se o intervalo atual é uma linha inteira.

linkedDataTypeState

Para CADA ITEM na coleção: Representa o estado do tipo de dados de cada célula.

numberFormat

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

numberFormatLocal

Para CADA ITEM na coleção: 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

Para EACH ITEM na coleção: Retorna o número total de linhas no intervalo.

rowHidden

Para EACH ITEM na coleção: 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

Para CADA ITEM na coleção: Retorna o número da linha da primeira célula do intervalo. Indexados com zero.

style

Para CADA ITEM na coleção: Representa o estilo do 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

Para EACH ITEM na coleção: 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.

values

Para EACH ITEM na coleção: 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.

valueTypes

Para CADA ITEM na coleção: Especifica o tipo de dados em cada célula.

worksheet

Para CADA ITEM da coleção: a planilha que contém o intervalo atual.

Detalhes da propriedade

$all

Especificar $all as opções de carga carrega todas as propriedades escalares (comoRange.address ), mas não as propriedades de navegação (como Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

address

Para CADA ITEM na coleção: 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").

address?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

addressLocal

Para EACH ITEM na coleção: Representa a referência de intervalo para o intervalo especificado no idioma do usuário.

addressLocal?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

cellCount

Para CADA ITEM na coleção: 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).

cellCount?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

columnCount

Para CADA ITEM na coleção: Especifica o número total de colunas no intervalo.

columnCount?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

columnHidden

Para EACH ITEM na coleção: 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

Para EACH ITEM na coleção: Especifica o número da coluna da primeira célula no intervalo. Indexados com zero.

columnIndex?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

dataValidation

Para CADA ITEM na coleção: Retorna um objeto de validação de dados.

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

format

Para CADA ITEM na coleção: Retorna um objeto de formato, encapsulando a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.

format?: Excel.Interfaces.RangeFormatLoadOptions;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

formulas

Para EACH ITEM na coleção: Representa a fórmula em notação no estilo A1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

formulas?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

formulasLocal

Para CADA ITEM na coleção: Representa a fórmula em notação no estilo A1, no idioma do usuário e na localidade de formatação de número. 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?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

formulasR1C1

Para EACH ITEM na coleção: Representa a fórmula em notação no estilo R1C1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

formulasR1C1?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.2

hidden

Para EACH ITEM na coleção: 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.

hidden?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.2

Para EACH ITEM na coleção: Representa o hiperlink para o intervalo atual.

hyperlink?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.7

isEntireColumn

Para EACH ITEM na coleção: Representa se o intervalo atual é uma coluna inteira.

isEntireColumn?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.7

isEntireRow

Para EACH ITEM na coleção: Representa se o intervalo atual é uma linha inteira.

isEntireRow?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.7

linkedDataTypeState

Para CADA ITEM na coleção: Representa o estado do tipo de dados de cada célula.

linkedDataTypeState?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.9

numberFormat

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

numberFormat?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

numberFormatLocal

Para CADA ITEM na coleção: 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?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.7

rowCount

Para EACH ITEM na coleção: Retorna o número total de linhas no intervalo.

rowCount?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

rowHidden

Para EACH ITEM na coleção: 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

Para CADA ITEM na coleção: Retorna o número da linha da primeira célula do intervalo. Indexados com zero.

rowIndex?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

style

Para CADA ITEM na coleção: Representa o estilo do 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?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.7

text

Para EACH ITEM na coleção: 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.

text?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

values

Para EACH ITEM na coleção: 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?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

valueTypes

Para CADA ITEM na coleção: Especifica o tipo de dados em cada célula.

valueTypes?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.1

worksheet

Para CADA ITEM da coleção: a planilha que contém o intervalo atual.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9