Excel.Application class

Excel.CalculationMode の定数で定義されている、ブックで使用される計算モードを返します。 指定可能な値は、 Automatic (Excel が再計算を制御します)、 AutomaticExceptTables (Excel が再計算を制御しますが、テーブルの変更を無視します)、 Manual (ユーザーの要求に応じて計算が行われます) です。 これはランタイム プロパティです。 calculationMode設定はブックに保持されません。

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

プロパティ値

注釈

API セット: getの場合はExcelApi 1.1、set の場合は1.8

例

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

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel で現在開いているすべてのブックを再計算します。

calculate(calculationType: Excel.CalculationType): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.1

例

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

Excel で現在開いているすべてのブックを再計算します。

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

パラメーター

返品

注釈

API セット: ExcelApi 1.1

例

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

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

例

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

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

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.Application): void;

パラメーター

返品

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Application オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ApplicationData と型指定) を返します。

toJSON(): Excel.Interfaces.ApplicationData;

返品