Excel.Interfaces.RangeCollectionLoadOptions interface

Pacote:

excel

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

$all	Especificar $all para loadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: 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 da folha (por exemplo, "Folha1! A1:B4").
addressLocal	Para CADA ITEM na coleção: representa a referência de intervalo para o intervalo especificado no idioma do utilizador.
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 CADA ITEM na coleção: representa se todas as colunas no intervalo atual estão ocultas. O valor é true quando todas as colunas num intervalo estão ocultas. O valor é false quando não existem colunas no intervalo ocultadas. O valor é null quando algumas colunas num intervalo estão ocultas e outras colunas no mesmo intervalo não estão ocultas.
columnIndex	Para CADA ITEM na coleção: especifica o número da coluna da primeira célula no intervalo. Indexados com zero.
control	Para CADA ITEM na coleção: acede ao controlo de célula aplicado a este intervalo. Se o intervalo tiver vários controlos de célula, devolve EmptyCellControl.
dataValidation	Para CADA ITEM na coleção: Devolve um objeto de validação de dados.
format	Para CADA ITEM na coleção: Devolve um objeto de formato, encapsulando o tipo de letra, o preenchimento, os limites, o alinhamento e outras propriedades do intervalo.
formulas	Para CADA ITEM na coleção: representa a fórmula na notação de estilo A1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
formulasLocal	Para CADA ITEM na coleção: representa a fórmula na notação de estilo A1, no idioma do utilizador e na região de formatação de números. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
formulasR1C1	Para CADA ITEM na coleção: representa a fórmula na notação de estilo R1C1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
hasSpill	Para CADA ITEM na coleção: representa se todas as células têm um limite de transposição. Devolve true se todas as células tiverem um limite de transposição ou false se todas as células não tiverem um limite de transposição. Devolve null se existirem células com e sem limites de transposição dentro do intervalo.
height	Para CADA ITEM na coleção: Devolve a distância em pontos, para um zoom de 100%, desde a margem superior do intervalo até à margem inferior do intervalo.
hidden	Para CADA ITEM na coleção: representa se todas as células no intervalo atual estão ocultas. O valor é true quando todas as células num intervalo estão ocultas. O valor é false quando não existem células no intervalo ocultadas. O valor é null quando algumas células num intervalo estão ocultas e outras células no mesmo intervalo não estão ocultas.
hyperlink	Para CADA ITEM na coleção: representa a hiperligação para o intervalo atual.
isEntireColumn	Para CADA ITEM na coleção: representa se o intervalo atual é uma coluna inteira.
isEntireRow	Para CADA ITEM na coleção: representa se o intervalo atual é uma linha inteira.
left	Para CADA ITEM na coleção: Devolve a distância em pontos, para uma ampliação de 100%, desde o limite esquerdo da folha de cálculo até à margem esquerda do intervalo.
linkedDataTypeState	Para CADA ITEM na coleção: representa o estado do tipo de dados de cada célula.
numberFormat	Para CADA ITEM na coleção: representa o código de formato de número do Excel para o intervalo especificado. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número.
numberFormatCategories	Para CADA ITEM na coleção: representa a categoria do formato de número de cada célula.
numberFormatLocal	Para CADA ITEM na coleção: representa o código de formato de número do Excel para o intervalo especificado, com base nas definições de idioma do utilizador. O Excel não executa qualquer idioma ou coerção de formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto devolvido utiliza as cadeias formatadas localmente com base no idioma especificado nas definições do sistema.
rowCount	Para CADA ITEM na coleção: Devolve o número total de linhas no intervalo.
rowHidden	Para CADA ITEM na coleção: representa se todas as linhas no intervalo atual estão ocultas. O valor é true quando todas as linhas num intervalo estão ocultas. O valor é false quando não existem linhas no intervalo ocultadas. O valor é null quando algumas linhas num intervalo estão ocultas e outras linhas no mesmo intervalo não estão ocultas.
rowIndex	Para CADA ITEM na coleção: Devolve o número de linha da primeira célula no intervalo. Indexados com zero.
savedAsArray	Para CADA ITEM na coleção: representa se todas as células seriam guardadas como uma fórmula de matriz. Devolve true se todas as células fossem guardadas como uma fórmula de matriz ou false se todas as células não fossem guardadas como uma fórmula de matriz. Devolve null se algumas células fossem guardadas como uma fórmula de matriz e algumas não seriam.
style	Para CADA ITEM na coleção: representa o estilo do intervalo atual. Se os estilos das células forem inconsistentes, null serão devolvidos. Para estilos personalizados, o nome do estilo será devolvido. Para estilos incorporados, será devolvida uma cadeia que representa um valor na BuiltInStyle enumeração.
text	Para CADA 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 IU do Excel não afetará o valor de texto devolvido pela API.
top	Para CADA ITEM na coleção: Devolve a distância em pontos, para uma ampliação de 100%, desde a margem superior da folha de cálculo até à margem superior do intervalo.
values	Para CADA ITEM na coleção: representa os valores não processados do intervalo especificado. Os dados devolvidos podem ser uma cadeia, número ou booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor devolvido começar com uma adição ("+"), sinal de subtração ("-"), ou sinal de igual ("="), o Excel interpreta este valor como uma fórmula.
valuesAsJson	Para CADA ITEM na coleção: uma representação JSON dos valores nas células deste intervalo. Ao contrário Range.valuesde , Range.valuesAsJson suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize Range.valuesAsJsonLocal.
valuesAsJsonLocal	Para CADA ITEM na coleção: uma representação JSON dos valores nas células deste intervalo. Ao contrário Range.valuesde , Range.valuesAsJsonLocal suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize Range.valuesAsJson.
valueTypes	Para CADA ITEM na coleção: especifica o tipo de dados em cada célula.
width	Para CADA ITEM na coleção: Devolve a distância em pontos, para uma ampliação de 100%, desde a margem esquerda do intervalo até à margem direita do intervalo.
worksheet	Para CADA ITEM na coleção: a folha de cálculo que contém o intervalo atual.

Detalhes da propriedade

$all

Especificar $all para loadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: 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 da folha (por exemplo, "Folha1! A1:B4").

address?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

addressLocal

Para CADA ITEM na coleção: representa a referência de intervalo para o intervalo especificado no idioma do utilizador.

addressLocal?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 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 API: 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 API: ExcelApi 1.1 ]

columnHidden

Para CADA ITEM na coleção: representa se todas as colunas no intervalo atual estão ocultas. O valor é true quando todas as colunas num intervalo estão ocultas. O valor é false quando não existem colunas no intervalo ocultadas. O valor é null quando algumas colunas num 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 API: ExcelApi 1.2 ]

columnIndex

Para CADA 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 API: ExcelApi 1.1 ]

control

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: acede ao controlo de célula aplicado a este intervalo. Se o intervalo tiver vários controlos de célula, devolve EmptyCellControl.

control?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

dataValidation

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

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

Valor da propriedade

Excel.Interfaces.DataValidationLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

format

Para CADA ITEM na coleção: Devolve um objeto de formato, encapsulando o tipo de letra, o preenchimento, os limites, o alinhamento e outras propriedades do intervalo.

format?: Excel.Interfaces.RangeFormatLoadOptions;

Valor da propriedade

Excel.Interfaces.RangeFormatLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

formulas

Para CADA ITEM na coleção: representa a fórmula na notação de estilo A1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.

formulas?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

formulasLocal

Para CADA ITEM na coleção: representa a fórmula na notação de estilo A1, no idioma do utilizador e na região de formatação de números. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.

formulasLocal?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

formulasR1C1

Para CADA ITEM na coleção: representa a fórmula na notação de estilo R1C1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.

formulasR1C1?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

hasSpill

Para CADA ITEM na coleção: representa se todas as células têm um limite de transposição. Devolve true se todas as células tiverem um limite de transposição ou false se todas as células não tiverem um limite de transposição. Devolve null se existirem células com e sem limites de transposição dentro do intervalo.

hasSpill?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

height

Para CADA ITEM na coleção: Devolve a distância em pontos, para um zoom de 100%, desde a margem superior do intervalo até à margem inferior do intervalo.

height?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

hidden

Para CADA ITEM na coleção: representa se todas as células no intervalo atual estão ocultas. O valor é true quando todas as células num intervalo estão ocultas. O valor é false quando não existem células no intervalo ocultadas. O valor é null quando algumas células num intervalo estão ocultas e outras células no mesmo intervalo não estão ocultas.

hidden?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

hyperlink

Para CADA ITEM na coleção: representa a hiperligação para o intervalo atual.

hyperlink?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

isEntireColumn

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

isEntireColumn?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

isEntireRow

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

isEntireRow?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

left

Para CADA ITEM na coleção: Devolve a distância em pontos, para uma ampliação de 100%, desde o limite esquerdo da folha de cálculo até à margem esquerda do intervalo.

left?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

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 API: ExcelApi 1.9 ]

numberFormat

Para CADA ITEM na coleção: representa o código de formato de número do Excel para o intervalo especificado. 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 API: ExcelApi 1.1 ]

numberFormatCategories

Para CADA ITEM na coleção: representa a categoria do formato de número de cada célula.

numberFormatCategories?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

numberFormatLocal

Para CADA ITEM na coleção: representa o código de formato de número do Excel para o intervalo especificado, com base nas definições de idioma do utilizador. O Excel não executa qualquer idioma ou coerção de formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto devolvido utiliza as cadeias formatadas localmente com base no idioma especificado nas definições do sistema.

numberFormatLocal?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

rowCount

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

rowCount?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

rowHidden

Para CADA ITEM na coleção: representa se todas as linhas no intervalo atual estão ocultas. O valor é true quando todas as linhas num intervalo estão ocultas. O valor é false quando não existem linhas no intervalo ocultadas. O valor é null quando algumas linhas num 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 API: ExcelApi 1.2 ]

rowIndex

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

rowIndex?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

savedAsArray

Para CADA ITEM na coleção: representa se todas as células seriam guardadas como uma fórmula de matriz. Devolve true se todas as células fossem guardadas como uma fórmula de matriz ou false se todas as células não fossem guardadas como uma fórmula de matriz. Devolve null se algumas células fossem guardadas como uma fórmula de matriz e algumas não seriam.

savedAsArray?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

style

Para CADA ITEM na coleção: representa o estilo do intervalo atual. Se os estilos das células forem inconsistentes, null serão devolvidos. Para estilos personalizados, o nome do estilo será devolvido. Para estilos incorporados, será devolvida uma cadeia que representa um valor na BuiltInStyle enumeração.

style?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

text

Para CADA 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 IU do Excel não afetará o valor de texto devolvido pela API.

text?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

top

Para CADA ITEM na coleção: Devolve a distância em pontos, para uma ampliação de 100%, desde a margem superior da folha de cálculo até à margem superior do intervalo.

top?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

values

Para CADA ITEM na coleção: representa os valores não processados do intervalo especificado. Os dados devolvidos podem ser uma cadeia, número ou booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor devolvido começar com uma adição ("+"), sinal de subtração ("-"), ou sinal de igual ("="), o Excel interpreta este valor como uma fórmula.

values?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

valuesAsJson

Para CADA ITEM na coleção: uma representação JSON dos valores nas células deste intervalo. Ao contrário Range.valuesde , Range.valuesAsJson suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize Range.valuesAsJsonLocal.

valuesAsJson?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

valuesAsJsonLocal

Para CADA ITEM na coleção: uma representação JSON dos valores nas células deste intervalo. Ao contrário Range.valuesde , Range.valuesAsJsonLocal suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize Range.valuesAsJson.

valuesAsJsonLocal?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

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 API: ExcelApi 1.1 ]

width

Para CADA ITEM na coleção: Devolve a distância em pontos, para uma ampliação de 100%, desde a margem esquerda do intervalo até à margem direita do intervalo.

width?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

worksheet

Para CADA ITEM na coleção: a folha de cálculo que contém o intervalo atual.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valor da propriedade

Excel.Interfaces.WorksheetLoadOptions

Comentários

[ Conjunto de API: ExcelApi 1.1 ]