Excel.RangeView class
RangeView representa um conjunto de células visíveis do intervalo pai.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.3 ]
Propriedades
| cell |
Representa os endereços das células do |
| column |
O número de colunas visíveis. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| 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. |
| index | Devolve um valor que representa o índice de |
| number |
Representa o código de formato de número do Excel para determinada célula. |
| row |
O número de linhas visíveis. |
| rows | Representa uma coleção de exibições de tabelas associadas ao intervalo. |
| text | Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição do sinal # que ocorre na interface do usuário do Excel não afeta o valor de texto retornado pela API. |
| values | Representa os valores brutos da exibição do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro. |
| value |
Representa o tipo de dados de cada célula. |
Métodos
| get |
Obtém o intervalo principal associado ao atual |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
cellAddresses
Representa os endereços das células do RangeView.
readonly cellAddresses: any[][];Valor da propriedade
any[][]
Comentários
columnCount
O número de colunas visíveis.
readonly columnCount: number;Valor da propriedade
number
Comentários
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
formulas
Representa a fórmula em notação A1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
formulas: any[][];Valor da propriedade
any[][]
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: any[][];Valor da propriedade
any[][]
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: any[][];Valor da propriedade
any[][]
Comentários
index
Devolve um valor que representa o índice de RangeView.
readonly index: number;Valor da propriedade
number
Comentários
numberFormat
Representa o código de formato de número do Excel para determinada célula.
numberFormat: any[][];Valor da propriedade
any[][]
Comentários
rowCount
O número de linhas visíveis.
readonly rowCount: number;Valor da propriedade
number
Comentários
rows
Representa uma coleção de exibições de tabelas associadas ao intervalo.
readonly rows: Excel.RangeViewCollection;Valor da propriedade
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 # que ocorre na interface do usuário do Excel não afeta o valor de texto retornado pela API.
readonly text: string[][];Valor da propriedade
string[][]
Comentários
values
Representa os valores brutos da exibição do intervalo especificado. Os dados retornados podem ser dos tipos: cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro.
values: any[][];Valor da propriedade
any[][]
Comentários
valueTypes
Representa o tipo de dados de cada célula.
readonly valueTypes: Excel.RangeValueType[][];Valor da propriedade
Comentários
Detalhes do método
getRange()
Obtém o intervalo principal associado ao atual RangeView.
getRange(): Excel.Range;Retornos
Comentários
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.RangeViewLoadOptions): Excel.RangeView;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
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.RangeView;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
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.RangeView;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.RangeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.RangeViewUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente 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 quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Excel.RangeView): void;Parâmetros
- properties
- Excel.RangeView
Retornos
void
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.RangeView é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.RangeViewData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.RangeViewData;