Excel.Application class
Representa o aplicativo Excel que gerencia a pasta de trabalho.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.1]
Propriedades
| calculation |
Retorna a versão do mecanismo de cálculo do Excel usada para o último recálculo completo. |
| calculation |
Retorna o modo de cálculo usado na pasta de trabalho, conforme definido pelas constantes em |
| calculation |
Retorna o estado de cálculo do aplicativo. Consulte |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| culture |
Fornece informações com base nas configurações atuais da cultura do sistema. Isso inclui os nomes das culturas, formatação de números e outras configurações culturalmente dependentes. |
| decimal |
Obtém a cadeia de caracteres usada como separador decimal para valores numéricos. Isso se baseia nas configurações locais do Excel. |
| iterative |
Retorna as configurações de cálculo iterativo. No Excel no Windows e Mac, as configurações serão aplicadas ao aplicativo Excel. No Excel na Web e em outras plataformas, as configurações serão aplicadas à pasta de trabalho ativa. |
| thousands |
Obtém a cadeia de caracteres usada para separar grupos de dígitos à esquerda do decimal para valores numéricos. Isso se baseia nas configurações locais do Excel. |
| use |
Especifica se os separadores do sistema do Excel estão habilitados. Os separadores do sistema incluem o separador decimal e o separador de milhar. |
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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| suspend |
Suspende o cálculo até que o próximo |
| suspend |
Suspende a atualização da tela até que a próxima
Observação: não ligue |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
calculationEngineVersion
Retorna a versão do mecanismo de cálculo do Excel usada para o último recálculo completo.
readonly calculationEngineVersion: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.9]
calculationMode
Retorna o modo de cálculo usado na pasta de trabalho, conforme definido pelas constantes em Excel.CalculationMode. Os valores possíveis são: Automatic, em que o Excel controla o recálculo; , em que o Excel controla o recálculo,AutomaticExceptTables mas ignora as alterações nas tabelas; Manual, onde o cálculo é feito quando o usuário o solicita. Essa é uma propriedade de runtime. A calculationMode configuração não é mantida na pasta de trabalho.
calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";
Valor da propriedade
Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"
Comentários
[Conjunto de apis: ExcelApi 1.1 para obter, 1.8 para definir]
calculationState
Retorna o estado de cálculo do aplicativo. Consulte Excel.CalculationState para obter detalhes.
readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending";
Valor da propriedade
Excel.CalculationState | "Done" | "Calculating" | "Pending"
Comentários
[Conjunto de apis: ExcelApi 1.9]
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;
Valor da propriedade
cultureInfo
Fornece informações com base nas configurações atuais da cultura do sistema. Isso inclui os nomes das culturas, formatação de números e outras configurações culturalmente dependentes.
readonly cultureInfo: Excel.CultureInfo;
Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.11]
decimalSeparator
Obtém a cadeia de caracteres usada como separador decimal para valores numéricos. Isso se baseia nas configurações locais do Excel.
readonly decimalSeparator: string;
Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.11]
iterativeCalculation
Retorna as configurações de cálculo iterativo. No Excel no Windows e Mac, as configurações serão aplicadas ao aplicativo Excel. No Excel na Web e em outras plataformas, as configurações serão aplicadas à pasta de trabalho ativa.
readonly iterativeCalculation: Excel.IterativeCalculation;
Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.9]
thousandsSeparator
Obtém a cadeia de caracteres usada para separar grupos de dígitos à esquerda do decimal para valores numéricos. Isso se baseia nas configurações locais do Excel.
readonly thousandsSeparator: string;
Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.11]
useSystemSeparators
Especifica se os separadores do sistema do Excel estão habilitados. Os separadores do sistema incluem o separador decimal e o separador de milhar.
readonly useSystemSeparators: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.11]
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. Consulte Excel.CalculationType para obter detalhes.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.1]
calculate(calculationType)
Recalcula todas as pastas de trabalho abertas no Excel no momento.
calculate(calculationType: "Recalculate" | "Full" | "FullRebuild"): void;
Parâmetros
- calculationType
-
"Recalculate" | "Full" | "FullRebuild"
Especifica o tipo de cálculo a usar. Consulte Excel.CalculationType para obter detalhes.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.1]
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 quais propriedades do objeto devem ser carregadas.
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 de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
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.Application;
Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente 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 propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Excel.Application): void;
Parâmetros
- properties
- Excel.Application
Retornos
void
suspendApiCalculationUntilNextSync()
Suspende o cálculo até que o próximo context.sync() seja chamado. Uma vez definido, é responsabilidade do desenvolvedor recalcular a pasta de trabalho, para garantir que todas as dependências sejam propagadas.
suspendApiCalculationUntilNextSync(): void;
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.6]
suspendScreenUpdatingUntilNextSync()
Suspende a atualização da tela até que a próxima context.sync() seja chamada.
Observação: não ligue suspendScreenUpdatingUntilNextSync repetidamente (como em um loop). Chamadas repetidas farão com que a janela do Excel pisque.
suspendScreenUpdatingUntilNextSync(): void;
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.9]
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Application é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ApplicationData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.ApplicationData;