Excel.Interfaces.RangeLoadOptions interface
O 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 utilizados em toda a API, comece com Intervalos na API JavaScript do Excel.
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
$all | Especificar |
address | 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 |
Representa a referência de intervalo para o intervalo especificado no idioma do utilizador. |
cell |
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). |
column |
Especifica o número total de colunas no intervalo. |
column |
Representa se todas as colunas no intervalo atual estão ocultas. O valor é |
column |
Especifica o número da coluna da primeira célula no intervalo. Indexados com zero. |
control | Acede ao controlo de células aplicado a este intervalo. Se o intervalo tiver vários controlos de célula, devolve |
data |
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 nenhuma fórmula, é devolvido o respetivo valor. |
formulas |
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 nenhuma fórmula, é devolvido o respetivo valor. |
formulasR1C1 | Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor. |
has |
Representa se todas as células têm uma borda de despejo. Devolve |
height | Devolve a distância em pontos, para 100% de zoom, desde a margem superior do intervalo até à margem inferior do intervalo. |
hidden | Representa se todas as células no intervalo atual estão ocultas. O valor é |
hyperlink | Representa a hiperligação para o intervalo atual. |
is |
Representa se o intervalo atual está em uma coluna inteira. |
is |
Representa se o intervalo atual está em uma linha inteira. |
left | Devolve a distância em pontos, para uma ampliação de 100%, desde a margem esquerda da folha de cálculo até à margem esquerda do intervalo. |
linked |
Representa o estado do tipo de dados de cada célula. |
number |
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. |
number |
Representa a categoria do formato de número de cada célula. |
number |
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 |
row |
Retorna o número total de linhas no intervalo. |
row |
Representa se todas as linhas no intervalo atual estão ocultas. O valor é |
row |
Representa o número de linhas da primeira célula no intervalo. Indexados com zero. |
saved |
Representa se todas as células seriam guardadas como uma fórmula de matriz. Devolve |
style | Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes, |
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 IU do Excel não afetará o valor de texto devolvido pela API. |
top | 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 | Representa os valores brutos 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 |
Uma representação JSON dos valores nas células deste intervalo. Ao contrário |
values |
Uma representação JSON dos valores nas células deste intervalo. Ao contrário |
value |
Especifica o tipo de dados em cada célula. |
width | Devolve a distância em pontos, para um zoom de 100%, desde a margem esquerda do intervalo até à margem direita do intervalo. |
worksheet | A planilha 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
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
addressLocal
Representa a referência de intervalo para o intervalo especificado no idioma do utilizador.
addressLocal?: boolean;
Valor da propriedade
boolean
Comentários
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).
cellCount?: boolean;
Valor da propriedade
boolean
Comentários
columnCount
Especifica o número total de colunas no intervalo.
columnCount?: boolean;
Valor da propriedade
boolean
Comentários
columnHidden
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
columnIndex
Especifica o número da coluna da primeira célula no intervalo. Indexados com zero.
columnIndex?: boolean;
Valor da propriedade
boolean
Comentários
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.
Acede ao controlo de células 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
Retorna um objeto de validação de dados.
dataValidation?: Excel.Interfaces.DataValidationLoadOptions;
Valor da propriedade
Comentários
format
Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.
format?: Excel.Interfaces.RangeFormatLoadOptions;
Valor da propriedade
Comentários
formulas
Representa a fórmula em notação A1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
formulas?: boolean;
Valor da propriedade
boolean
Comentários
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 nenhuma fórmula, é devolvido o respetivo valor.
formulasLocal?: boolean;
Valor da propriedade
boolean
Comentários
formulasR1C1
Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
formulasR1C1?: boolean;
Valor da propriedade
boolean
Comentários
hasSpill
Representa se todas as células têm uma borda de despejo. 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
height
Devolve a distância em pontos, para 100% de zoom, desde a margem superior do intervalo até à margem inferior do intervalo.
height?: boolean;
Valor da propriedade
boolean
Comentários
hidden
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
hyperlink
Representa a hiperligação para o intervalo atual.
hyperlink?: boolean;
Valor da propriedade
boolean
Comentários
isEntireColumn
Representa se o intervalo atual está em uma coluna inteira.
isEntireColumn?: boolean;
Valor da propriedade
boolean
Comentários
isEntireRow
Representa se o intervalo atual está em uma linha inteira.
isEntireRow?: boolean;
Valor da propriedade
boolean
Comentários
left
Devolve a distância em pontos, para uma ampliação de 100%, desde a margem esquerda da folha de cálculo até à margem esquerda do intervalo.
left?: boolean;
Valor da propriedade
boolean
Comentários
linkedDataTypeState
Representa o estado do tipo de dados de cada célula.
linkedDataTypeState?: boolean;
Valor da propriedade
boolean
Comentários
numberFormat
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
numberFormatCategories
Representa a categoria do formato de número de cada célula.
numberFormatCategories?: boolean;
Valor da propriedade
boolean
Comentários
numberFormatLocal
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
rowCount
Retorna o número total de linhas no intervalo.
rowCount?: boolean;
Valor da propriedade
boolean
Comentários
rowHidden
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
rowIndex
Representa o número de linhas da primeira célula no intervalo. Indexados com zero.
rowIndex?: boolean;
Valor da propriedade
boolean
Comentários
savedAsArray
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
style
Representa o estilo de 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
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 IU do Excel não afetará o valor de texto devolvido pela API.
text?: boolean;
Valor da propriedade
boolean
Comentários
top
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
values
Representa os valores brutos 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
valuesAsJson
Uma representação JSON dos valores nas células deste intervalo. Ao contrário Range.values
de , 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
valuesAsJsonLocal
Uma representação JSON dos valores nas células deste intervalo. Ao contrário Range.values
de , 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
valueTypes
Especifica o tipo de dados em cada célula.
valueTypes?: boolean;
Valor da propriedade
boolean
Comentários
width
Devolve a distância em pontos, para um zoom de 100%, desde a margem esquerda do intervalo até à margem direita do intervalo.
width?: boolean;
Valor da propriedade
boolean
Comentários
worksheet
A planilha que contém o intervalo atual.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;