Excel.Application class

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

readonly calculationEngineVersion: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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é

Remarques

Jeu d’API : ExcelApi 1.1 pour obtenir, 1.8 pour définir

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-calculation.yaml

await Excel.run(async (context) => {
  context.application.calculationMode = Excel.CalculationMode.manual;
  context.application.load("calculationMode");
  await context.sync();

  console.log("Current calculation mode: " + context.application.calculationMode);
});

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é

Remarques

Jeu d’API : ExcelApi 1.9

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é

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

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info-date-time.yaml

await Excel.run(async (context) => {
  context.application.cultureInfo.datetimeFormat.load([
    "longDatePattern",
    "shortDatePattern",
    "dateSeparator",
    "longTimePattern",
    "timeSeparator"
  ]);
  await context.sync();

  // Use the cultural settings API to retrieve the user's system date and time settings.
  const systemLongDatePattern = context.application.cultureInfo.datetimeFormat.longDatePattern;
  const systemShortDatePattern = context.application.cultureInfo.datetimeFormat.shortDatePattern;
  const systemDateSeparator = context.application.cultureInfo.datetimeFormat.dateSeparator;
  const systemLongTimePattern = context.application.cultureInfo.datetimeFormat.longTimePattern;
  const systemTimeSeparator = context.application.cultureInfo.datetimeFormat.timeSeparator;

  // Display the date and time settings in your console.
  console.log("System date/time settings: ");
  console.log(`  System long date format: ${systemLongDatePattern}`);
  console.log(`  System short date format: ${systemShortDatePattern}`);
  console.log(`  System date separator: ${systemDateSeparator}`);
  console.log(`  System long time format: ${systemLongTimePattern}`);
  console.log(`  System time separator: ${systemTimeSeparator}`);

  await context.sync();
});

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é

Remarques

Jeu 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();
});

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

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é

Remarques

Jeu d’API : ExcelApi 1.11

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é

Remarques

Jeu d’API : ExcelApi 1.11

Recalcule tous les classeurs actuellement ouverts dans Excel.

calculate(calculationType: Excel.CalculationType): void;

Paramètres

Retours

Remarques

Jeu 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);
});

Recalcule tous les classeurs actuellement ouverts dans Excel.

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

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

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

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

Retours

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

Retours

Exemples

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

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

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

Retours

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

Retours

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

Retours

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

Remarques

Jeu d’API : ExcelApi 1.6

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

Remarques

Jeu 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://learn.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`);
});

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