Excel.Application class
Representa o aplicativo Excel que gerencia a pasta de trabalho.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| calculation |
Devolve o modo de cálculo utilizado no livro, conforme definido pelas constantes em |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
Métodos
| calculate(calculation |
Recalcula todas as pastas de trabalho abertas no Excel no momento. |
| calculate(calculation |
Recalcula todas as pastas de trabalho abertas no Excel no momento. |
| 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
calculationMode
Devolve o modo de cálculo utilizado no livro, conforme definido pelas constantes em Excel.CalculationMode. Os valores possíveis são: Automatic, em que o Excel controla o recálculo; AutomaticExceptTables, em que o Excel controla o recálculo, mas ignora as alterações nas tabelas; Manual, onde o cálculo é feito quando o utilizador o pede.
calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";Valor da propriedade
Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"
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
Detalhes do método
calculate(calculationType)
Recalcula todas as pastas de trabalho abertas no Excel no momento.
calculate(calculationType: Excel.CalculationType): void;Parâmetros
- calculationType
- Excel.CalculationType
Especifica o tipo de cálculo a usar. Veja Excel.CalculationType para obter detalhes.
Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml
await Excel.run(async (context) => {
context.application.calculate(Excel.CalculationType.full);
});
calculate(calculationTypeString)
Recalcula todas as pastas de trabalho abertas no Excel no momento.
calculate(calculationTypeString: "Recalculate" | "Full" | "FullRebuild"): void;Parâmetros
- calculationTypeString
-
"Recalculate" | "Full" | "FullRebuild"
Especifica o tipo de cálculo a usar. Veja Excel.CalculationType para obter detalhes.
Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
context.workbook.application.calculate('Full');
await context.sync();
});
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.ApplicationLoadOptions): Excel.Application;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.Application;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
Exemplos
await Excel.run(async (context) => {
const application = context.workbook.application;
application.load('calculationMode');
await context.sync();
console.log(application.calculationMode);
});
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.Application;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.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.ApplicationUpdateData
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.Application): void;Parâmetros
- properties
- Excel.Application
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.Application é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ApplicationData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ApplicationData;