Excel.Application class

Stellt die Excel-Anwendung dar, die die Arbeitsmappe verwaltet.

Extends

Eigenschaften

calculationMode

Gibt den in der Arbeitsmappe verwendeten Berechnungsmodus zurück, wie durch die Konstanten in Excel.CalculationModedefiniert. Mögliche Werte sind: Automatic, wobei Excel die Neuberechnung steuert; , wobei Excel die Neuberechnung steuert,AutomaticExceptTables Änderungen in Tabellen jedoch ignoriert; Manual, bei denen die Berechnung erfolgt, wenn der Benutzer sie anfordert. Dies ist eine Runtime-Eigenschaft. Diese calculationMode Einstellung wird in der Arbeitsmappe nicht beibehalten.

context

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

Methoden

calculate(calculationType)

Alle in Excel geöffnete Arbeitsmappen werden neu berechnet.

calculate(calculationType)

Alle in Excel geöffnete Arbeitsmappen werden neu berechnet.

load(options)

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)

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)

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.

set(properties, options)

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)

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

toJSON()

Ü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 sie übergeben wird.) Während das ursprüngliche Excel.Application Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.ApplicationData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

calculationMode

Gibt den in der Arbeitsmappe verwendeten Berechnungsmodus zurück, wie durch die Konstanten in Excel.CalculationModedefiniert. Mögliche Werte sind: Automatic, wobei Excel die Neuberechnung steuert; , wobei Excel die Neuberechnung steuert,AutomaticExceptTables Änderungen in Tabellen jedoch ignoriert; Manual, bei denen die Berechnung erfolgt, wenn der Benutzer sie anfordert. Dies ist eine Runtime-Eigenschaft. Diese calculationMode Einstellung wird in der Arbeitsmappe nicht beibehalten.

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

Eigenschaftswert

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

Hinweise

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

Beispiele

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

context

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

context: RequestContext;

Eigenschaftswert

Details zur Methode

calculate(calculationType)

Alle in Excel geöffnete Arbeitsmappen werden neu berechnet.

calculate(calculationType: Excel.CalculationType): void;

Parameter

calculationType
Excel.CalculationType

Gibt den zu verwendenden Berechnungstyp an. Weitere Informationen findest du hier Excel.CalculationType .

Gibt zurück

void

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

calculate(calculationType)

Alle in Excel geöffnete Arbeitsmappen werden neu berechnet.

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

Parameter

calculationType

"Recalculate" | "Full" | "FullRebuild"

Gibt den zu verwendenden Berechnungstyp an. Weitere Informationen findest du hier Excel.CalculationType .

Gibt zurück

void

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

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

load(options)

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

options
Excel.Interfaces.ApplicationLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

load(propertyNames)

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

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Beispiele

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

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

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

propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

set(properties, options)

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

properties
Excel.Interfaces.ApplicationUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

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

set(properties: Excel.Application): void;

Parameter

properties
Excel.Application

Gibt zurück

void

toJSON()

Ü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 sie übergeben wird.) Während das ursprüngliche Excel.Application Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.ApplicationData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.ApplicationData;

Gibt zurück