Excel.Application class

Paquet:

excel

Représente l’application Excel qui gère le classeur.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

calculationMode	Retourne le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans Excel.CalculationMode. Les valeurs possibles sont : Automatic, où Excel contrôle le recalcul ;AutomaticExceptTables , où Excel contrôle le recalcul mais ignore les modifications apportées aux tableaux ; Manual, où le calcul est effectué lorsque l’utilisateur le demande.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

Méthodes

calculate(calculationType)	Recalcule tous les classeurs actuellement ouverts dans Excel.
calculate(calculationTypeString)	Recalcule tous les classeurs actuellement ouverts dans Excel.
load(options)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
suspendApiCalculationUntilNextSync()	Suspend le calcul jusqu’à ce que le suivant context.sync() soit appelé. Une fois cette option définie, il incombe au développeur de recalculer le classeur afin de garantir que toutes les dépendances sont propagées.
toJSON()	Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.Application d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (tapé en tant Excel.Interfaces.ApplicationDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

calculationMode

Retourne le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans Excel.CalculationMode. Les valeurs possibles sont : Automatic, où Excel contrôle le recalcul ;AutomaticExceptTables , où Excel contrôle le recalcul mais ignore les modifications apportées aux tableaux ; Manual, où le calcul est effectué lorsque l’utilisateur le demande.

calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";

Valeur de propriété

Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"

Remarques

[ Ensemble d’API : ExcelApi 1.1 pour get, 1.8 pour set ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

Détails de la méthode

calculate(calculationType)

Recalcule tous les classeurs actuellement ouverts dans Excel.

calculate(calculationType: Excel.CalculationType): void;

Paramètres

calculationType

Excel.CalculationType

Spécifie le type de calcul à utiliser. Pour plus d’informations, consultez Excel.CalculationType .

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

// 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)

Recalcule tous les classeurs actuellement ouverts dans Excel.

calculate(calculationTypeString: "Recalculate" | "Full" | "FullRebuild"): void;

Paramètres

calculationTypeString

"Recalculate" | "Full" | "FullRebuild"

Spécifie le type de calcul à utiliser. Pour plus d’informations, consultez Excel.CalculationType .

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

await Excel.run(async (context) => {
    context.workbook.application.calculate('Full');
    await context.sync();
});

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application;

Paramètres

options

Excel.Interfaces.ApplicationLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.Application

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.Application;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.Application

Exemples

await Excel.run(async (context) => {
    const application = context.workbook.application;
    application.load('calculationMode');
    await context.sync();

    console.log(application.calculationMode);
});

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Application;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.Application

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Excel.Interfaces.ApplicationUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options

OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Application): void;

Paramètres

properties

Excel.Application

Retours

void

suspendApiCalculationUntilNextSync()

Suspend le calcul jusqu’à ce que le suivant context.sync() soit appelé. Une fois cette option définie, il incombe au développeur de recalculer le classeur afin de garantir que toutes les dépendances sont propagées.

suspendApiCalculationUntilNextSync(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.Application d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (tapé en tant Excel.Interfaces.ApplicationDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.ApplicationData;

Retours

Excel.Interfaces.ApplicationData