Excel.Application class

Gibt die Version der Excel-Berechnungsmaschine zurück, die für die letzte vollständige Neuberechnung verwendet wurde.

readonly calculationEngineVersion: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Gibt den in der Arbeitsmappe verwendeten Berechnungsmodus zurück, der durch die Konstanten in Excel.CalculationModedefiniert wird. Mögliche Werte sind: Automatic, wobei Excel die Neuberechnung steuert; AutomaticExceptTables, wobei Excel die Neuberechnung steuert, aber Änderungen in Tabellen ignoriert; Manual, wobei die Berechnung durchgeführt wird, wenn der Benutzer sie anfordert.

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 für get, 1.8 für set ]

Gibt den Berechnungszustand der Anwendung zurück. Weitere Informationen finden Sie unter Excel.CalculationState .

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Stellt Informationen basierend auf den aktuellen Systemkultureinstellungen bereit. Dies umfasst die Kulturnamen, die Zahlenformatierung und andere kulturabhängige Einstellungen.

readonly cultureInfo: Excel.CultureInfo;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Ruft die Zeichenfolge ab, die als Dezimaltrennzeichen für numerische Werte verwendet wird. Dies basiert auf den lokalen Excel-Einstellungen.

readonly decimalSeparator: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Beispiele

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

Gibt die iterativen Berechnungseinstellungen zurück. In Excel unter Windows und Mac gelten die Einstellungen für die Excel-Anwendung. Auf Excel im Web und anderen Plattformen gelten die Einstellungen für die aktive Arbeitsmappe.

readonly iterativeCalculation: Excel.IterativeCalculation;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Ruft die Zeichenfolge ab, mit der Gruppen von Ziffern links vom Dezimaltrennzeichen für numerische Werte getrennt werden. Dies basiert auf den lokalen Excel-Einstellungen.

readonly thousandsSeparator: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Gibt an, ob die Systemtrennzeichen von Excel aktiviert sind. Systemtrennzeichen enthalten das Dezimaltrennzeichen und das Tausendertrennzeichen.

readonly useSystemSeparators: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Alle in Excel geöffnete Arbeitsmappen werden neu berechnet.

calculate(calculationType: Excel.CalculationType): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

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

Alle in Excel geöffnete Arbeitsmappen werden neu berechnet.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

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

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Beispiele

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

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

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.Application): void;

Parameter

Gibt zurück

Hält die Berechnung an, bis die nächste context.sync() aufgerufen wird. Nachdem dies festgelegt wurde, liegt es in der Verantwortung des Entwicklers, die Arbeitsmappe neu zu berechnen, um sicherzustellen, dass alle Abhängigkeiten verteilt werden.

suspendApiCalculationUntilNextSync(): void;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Hält die Bildschirmaktualisierung an, bis die nächste context.sync() aufgerufen wird.

Hinweis*: Rufen suspendScreenUpdatingUntilNextSync Sie nicht wiederholt auf (z. B. in einer Schleife). Wiederholte Aufrufe führen dazu, dass das Excel-Fenster flackert.

suspendScreenUpdatingUntilNextSync(): void;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Beispiele

// 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://video2.skills-academy.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`);
});

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Application Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ApplicationData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.ApplicationData;

Gibt zurück