Excel.Application class

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

Extends

Remarques

[Ensemble 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 workbook, tel que défini par les constantes dans Excel.CalculationMode. Les valeurs possibles sont les : 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.

calculationState

Renvoie l’état de calcul de l’application. Pour Excel.CalculationState plus d’informations, voir.

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

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épendant de la culture.

decimalSeparator

Obtient la chaîne utilisée comme séparateur décimal pour les valeurs numériques. Il est basé sur les paramètres de Excel locale.

iterativeCalculation

Renvoie les paramètres de calcul itératifs. Dans Excel sur Windows mac, les paramètres s’appliquent à l’Excel application. Dans Excel sur le Web d’autres plateformes, les paramètres s’appliquent au workbook actif.

thousandsSeparator

Obtient la chaîne utilisée pour séparer les groupes de chiffres à gauche de la virgule pour les valeurs numériques. Il est basé sur les paramètres de Excel locale.

useSystemSeparators

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

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 transmettre un objet simple avec les propriétés appropriées ou un autre objet API du même type.

set(properties)

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

suspendApiCalculationUntilNextSync()

Suspend le calcul jusqu’à ce que le context.sync() suivant 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’à ce que le context.sync() suivant soit appelé.

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

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Tandis que la Excel. Objet Application est un objet API, la toJSON méthode renvoie un objet JavaScript simple (tapé sous la formeExcel.Interfaces.ApplicationData) qui contient des copies superficiels 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

[Ensemble d’API : ExcelApi 1.9 ]

calculationMode

Renvoie le mode de calcul utilisé dans le workbook, tel que défini par les constantes dans Excel.CalculationMode. Les valeurs possibles sont les : 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.

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 ]

calculationState

Renvoie l’état de calcul de l’application. Pour Excel.CalculationState plus d’informations, voir.

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

Valeur de propriété

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

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

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épendant de la culture.

readonly cultureInfo: Excel.CultureInfo;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.11 ]

decimalSeparator

Obtient la chaîne utilisée comme séparateur décimal pour les valeurs numériques. Il est basé sur les paramètres de Excel locale.

readonly decimalSeparator: string;

Valeur de propriété

string

Remarques

[Ensemble d’API : ExcelApi 1.11 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info.yaml
await Excel.run(async (context) => {
  context.application.load("decimalSeparator,thousandsSeparator");
  context.application.cultureInfo.numberFormat.load("numberDecimalSeparator,numberGroupSeparator");
  await context.sync();

  // Local settings are set under the "Options > Advanced" menu.
  const localDecimalSeparator = context.application.decimalSeparator;
  const localThousandsSeparator = context.application.thousandsSeparator;

  const systemDecimalSeparator = context.application.cultureInfo.numberFormat.numberDecimalSeparator;
  const systemThousandsSeparator = context.application.cultureInfo.numberFormat.numberGroupSeparator;

  console.log("Local character settings: ");
  console.log(`  Local decimal separator: ${localDecimalSeparator}`);
  console.log(`  Local thousands separator: ${localThousandsSeparator}`);

  console.log("System culture settings: ");
  console.log(`  System decimal separator: ${systemDecimalSeparator}`);
  console.log(`  System thousands separator: ${systemThousandsSeparator}`);
  console.log(`  `);

  await context.sync();
});

iterativeCalculation

Renvoie les paramètres de calcul itératifs. Dans Excel sur Windows mac, les paramètres s’appliquent à l’Excel application. Dans Excel sur le Web d’autres plateformes, les paramètres s’appliquent au workbook actif.

readonly iterativeCalculation: Excel.IterativeCalculation;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

thousandsSeparator

Obtient la chaîne utilisée pour séparer les groupes de chiffres à gauche de la virgule pour les valeurs numériques. Il est basé sur les paramètres de Excel locale.

readonly thousandsSeparator: string;

Valeur de propriété

string

Remarques

[Ensemble d’API : ExcelApi 1.11 ]

useSystemSeparators

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

readonly useSystemSeparators: boolean;

Valeur de propriété

boolean

Remarques

[Ensemble 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 d’informations, voir.

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 Excel.CalculationType plus d’informations, voir.

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

Exemples

Excel.run(function (ctx) {
    ctx.workbook.application.calculate('Full');
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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 lesquelles 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

Exemples

Excel.run(function (ctx) {
    var application = ctx.workbook.application;
    application.load('calculationMode');
    return ctx.sync().then(function() {
        console.log(application.calculationMode);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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 est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre un objet simple 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 structurées de manière isomorphe aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

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

Retours

void

set(properties)

Définit plusieurs propriétés de 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 context.sync() suivant 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 ]

suspendScreenUpdatingUntilNextSync()

Suspend la mise à jour de l’écran jusqu’à ce que le context.sync() suivant soit appelé.

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

suspendScreenUpdatingUntilNextSync(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

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) => {
  // Recreate the data in the worksheet with random data.
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  const startTime = Date.now();
  console.log("Starting...");

  // If other parts of the sample have toggled screen painting off, this will stop screen updating until context.sync is called.
  if (pauseScreenPainting) {
    context.application.suspendScreenUpdatingUntilNextSync();
  }

  for (let i = 1; i < ROW_COUNT; i++) {
    for (let j = 1; j < COLUMN_COUNT; j++) {
      let cell = sheet.getCell(i, j);
      cell.values = [[i * j * Math.random()]];

      // If other parts of the sample have toggled tracking off, we will avoid tracking this range and having to manage the proxy objects.
      // For more information, see https://docs.microsoft.com/office/dev/add-ins/concepts/resource-limits-and-performance-optimization#untrack-unneeded-proxy-objects
      if (untrack) {
        cell.untrack();
      }
    }
  }

  await context.sync();

  console.log(`Ending. Adding ${ROW_COUNT * COLUMN_COUNT} cells took ${Date.now() - startTime} milliseconds`);
});

toJSON()

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

toJSON(): Excel.Interfaces.ApplicationData;

Retours