Excel.Application class

リファレンス

パッケージ:: excel

ブックを管理する Excel アプリケーションを表します。

Extends: OfficeExtension.ClientObject

注釈

プロパティ

の定数で定義されているブックで使用される計算モードを返します Excel.CalculationMode。使用可能な値は、です。Automaticここで、Excel は再計算を制御しますAutomaticExceptTables。この場合、Excel は再計算を制御しますが、Manualテーブルの変更は無視されます。ここで、計算はユーザーが要求したときに行われます。

context

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

メソッド

calculate(calculationType)	Excel で現在開いているすべてのブックを再計算します。
calculate(calculationTypeString)	Excel で現在開いているすべてのブックを再計算します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドを `JSON.stringify()`オーバーライドします。 (`JSON.stringify`さらに、渡されるオブジェクトのメソッドを呼び出 `toJSON` します)。元の Excel.Application オブジェクトは API オブジェクトですが、メソッドは、元の `toJSON` オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として `Excel.Interfaces.ApplicationData`型指定) を返します。

プロパティの詳細

calculationMode

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

プロパティ値

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

注釈

[ API set: ExcelApi 1.1 for get, 1.8 for set ]

context

context: RequestContext;

プロパティ値

Excel.RequestContext

メソッドの詳細

calculate(calculationType)

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

calculate(calculationType: Excel.CalculationType): void;

パラメーター

calculationType: Excel.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);
});

calculate(calculationTypeString)

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

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

パラメーター

calculationTypeString: "Recalculate" | "Full" | "FullRebuild"

使用する計算の種類を指定します。詳細は「Excel.CalculationType」をご覧ください。

戻り値

void

注釈

[ API セット: ExcelApi 1.1 ]

例

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

load(options)

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

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

パラメーター

options: Excel.Interfaces.ApplicationLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.Application

load(propertyNames)

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

パラメーター

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

load(propertyNamesAndPaths)

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

パラメーター

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

propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.Application

set(properties, options)

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

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

パラメーター

properties: Excel.Interfaces.ApplicationUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

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

set(properties: Excel.Application): void;

パラメーター

properties: Excel.Application

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.ApplicationData;

戻り値

Excel.Interfaces.ApplicationData

Excel.Application class

注釈

プロパティ

メソッド

プロパティの詳細

calculationMode

プロパティ値

注釈

context

プロパティ値

メソッドの詳細

calculate(calculationType)

パラメーター

戻り値

注釈

例

calculate(calculationTypeString)

パラメーター

戻り値

注釈

例

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

例

load(propertyNamesAndPaths)

パラメーター

戻り値

set(properties, options)

パラメーター

戻り値

set(properties)

パラメーター

戻り値

toJSON()

戻り値

フィードバック

その他のリソース