Excel.Application class

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

Extends

Remarques

[Jeu d’API : ExcelApi 1.1]

Propriétés

calculationEngineVersion

Renvoie la version du moteur de calcul Excel utilisée pour le dernier recalcul complet.

calculationMode

Renvoie le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans Excel.CalculationMode. Les valeurs possibles sont les suivantes : Automatic, où Excel contrôle le recalcul ;AutomaticExceptTables , où Excel contrôle le recalcul mais ignore les modifications apportées aux tables ; Manual, où le calcul est effectué lorsque l’utilisateur le demande. Il s’agit d’une propriété d’exécution. Le calculationMode paramètre n’est pas conservé dans le classeur.

calculationState

Renvoie l’état de calcul de l’application. Pour Excel.CalculationState plus de détails.

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

cultureInfo

Fournit des informations basées sur les paramètres de culture système actuels. Cela inclut les noms de culture, la mise en forme des nombres et d’autres paramètres dépendants de la culture.

decimalSeparator

Récupère la chaîne utilisée comme séparateur décimal pour les valeurs numériques. Cela est basé sur les paramètres Excel locaux.

iterativeCalculation

Renvoie les paramètres de calcul itératif. Dans Excel sur Windows et Mac, les paramètres s’appliquent à l’application Excel. Dans Excel sur le Web et sur les autres plateformes, les paramètres s’appliquent au classeur actif.

thousandsSeparator

Obtient la chaîne utilisée pour séparer les groupes de chiffres à gauche du séparateur décimal pour les valeurs numériques. Cela est basé sur les paramètres Excel locaux.

useSystemSeparators

Spécifie si les séparateurs système d’Excel sont activés. Les séparateurs de système comprennent le séparateur décimal et le séparateur de milliers.

Méthodes

calculate(calculationType)

Recalcule tous les classeurs actuellement ouverts dans Excel.

calculate(calculationType)

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 transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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.

suspendScreenUpdatingUntilNextSync()

Suspend la mise à jour de l’écran jusqu’à l’appel du suivant context.sync() .

Remarque : n’appelez suspendScreenUpdatingUntilNextSync pas à plusieurs reprises (par exemple, dans une boucle). Les appels répétés entraînent le scintillement de la fenêtre Excel.

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Application est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ApplicationDataqui 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é

calculationEngineVersion

Renvoie la version du moteur de calcul Excel utilisée pour le dernier recalcul complet.

readonly calculationEngineVersion: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.9]

calculationMode

Renvoie le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans Excel.CalculationMode. Les valeurs possibles sont les suivantes : Automatic, où Excel contrôle le recalcul ;AutomaticExceptTables , où Excel contrôle le recalcul mais ignore les modifications apportées aux tables ; Manual, où le calcul est effectué lorsque l’utilisateur le demande. Il s’agit d’une propriété d’exécution. Le calculationMode paramètre n’est pas conservé dans le classeur.

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

Valeur de propriété

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

Remarques

[Jeu d’API : ExcelApi 1.1 pour obtenir, 1.8 pour l’ensemble]

calculationState

Renvoie l’état de calcul de l’application. Pour Excel.CalculationState plus de détails.

readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending";

Valeur de propriété

Excel.CalculationState | "Done" | "Calculating" | "Pending"

Remarques

[Jeu d’API : ExcelApi 1.9]

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

cultureInfo

Fournit des informations basées sur les paramètres de culture système actuels. Cela inclut les noms de culture, la mise en forme des nombres et d’autres paramètres dépendants de la culture.

readonly cultureInfo: Excel.CultureInfo;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.11]

decimalSeparator

Récupère la chaîne utilisée comme séparateur décimal pour les valeurs numériques. Cela est basé sur les paramètres Excel locaux.

readonly decimalSeparator: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.11]

iterativeCalculation

Renvoie les paramètres de calcul itératif. Dans Excel sur Windows et Mac, les paramètres s’appliquent à l’application Excel. Dans Excel sur le Web et sur les autres plateformes, les paramètres s’appliquent au classeur actif.

readonly iterativeCalculation: Excel.IterativeCalculation;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.9]

thousandsSeparator

Obtient la chaîne utilisée pour séparer les groupes de chiffres à gauche du séparateur décimal pour les valeurs numériques. Cela est basé sur les paramètres Excel locaux.

readonly thousandsSeparator: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.11]

useSystemSeparators

Spécifie si les séparateurs système d’Excel sont activés. Les séparateurs de système comprennent le séparateur décimal et le séparateur de milliers.

readonly useSystemSeparators: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.11]

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 Excel.CalculationType plus de détails.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.1]

calculate(calculationType)

Recalcule tous les classeurs actuellement ouverts dans Excel.

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

Paramètres

calculationType

"Recalculate" | "Full" | "FullRebuild"

Spécifie le type de calcul à utiliser. Pour Excel.CalculationType plus de détails.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.1]

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

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 spécifiant les propriétés à charger.

Retours

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

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

properties
Excel.Interfaces.ApplicationUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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

[Jeu d’API : ExcelApi 1.6]

suspendScreenUpdatingUntilNextSync()

Suspend la mise à jour de l’écran jusqu’à l’appel du suivant context.sync() .

Remarque : n’appelez suspendScreenUpdatingUntilNextSync pas à plusieurs reprises (par exemple, dans une boucle). Les appels répétés entraînent le scintillement de la fenêtre Excel.

suspendScreenUpdatingUntilNextSync(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

toJSON()

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

toJSON(): Excel.Interfaces.ApplicationData;

Retours