Excel.Application class

ブックを管理する Excel アプリケーションを表します。Represents the Excel application that manages the workbook.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

Extends

プロパティ

calculationEngineVersion

最後の完全な再計算に使用した Excel 計算エンジンのバージョンを返します。Returns the Excel calculation engine version used for the last full recalculation. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

calculationMode

CalculationMode の定数によって定義されている、ブックで使用されている計算モードを返します。Returns the calculation mode used in the workbook, as defined by the constants in Excel.CalculationMode. 可能な値は次のとおりです。AutomaticPossible values are: Automatic、Excel は再計算を制御します。AutomaticExceptTables, where Excel controls recalculation; AutomaticExceptTables、Excel は再計算を制御しますが、テーブル内の変更は無視します。Manual, where Excel controls recalculation but ignores changes in tables; Manual、ユーザーが要求すると、計算が行われます。, where calculation is done when the user requests it.

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

calculationState

アプリケーションの計算の状態を返します。Returns the calculation state of the application. 詳細については、Excel.CalculationState をご覧ください。See Excel.CalculationState for details. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

iterativeCalculation

反復計算の設定を返します。Returns the Iterative Calculation settings. Windows と Mac の Excel では、設定は Excel アプリケーションに適用されます。In Excel on Windows and Mac, the settings will apply to the Excel Application. Web 上の Excel およびその他のプラットフォームでは、設定は作業中のブックに適用されます。In Excel on the web and other platforms, the settings will apply to the active workbook.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

メソッド

calculate(calculationType)

Excel で現在開いているすべてのブックを再計算します。Recalculate all currently opened workbooks in Excel.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

calculate(calculationTypeString)

Excel で現在開いているすべてのブックを再計算します。Recalculate all currently opened workbooks in Excel.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

suspendApiCalculationUntilNextSync()

次の "context.sync()" が呼び出されるまで、計算を中断します。設定されると、依存関係が確実に伝達されるようにブックを再計算するのは開発者の責任です。Suspends calculation until the next "context.sync()" is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

suspendScreenUpdatingUntilNextSync()

次の "context.sync()" が呼び出されるまで画面の更新を一時停止します。Suspends sceen updating until the next "context.sync()" is called.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel オブジェクトは API オブジェクトですが、このメソッドはtoJSON 、プレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.ApplicationData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Application object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ApplicationData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

calculationEngineVersion

最後の完全な再計算に使用した Excel 計算エンジンのバージョンを返します。Returns the Excel calculation engine version used for the last full recalculation. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly calculationEngineVersion: number;

プロパティ値

number

calculationMode

CalculationMode の定数によって定義されている、ブックで使用されている計算モードを返します。Returns the calculation mode used in the workbook, as defined by the constants in Excel.CalculationMode. 可能な値は次のとおりです。AutomaticPossible values are: Automatic、Excel は再計算を制御します。AutomaticExceptTables, where Excel controls recalculation; AutomaticExceptTables、Excel は再計算を制御しますが、テーブル内の変更は無視します。Manual, where Excel controls recalculation but ignores changes in tables; Manual、ユーザーが要求すると、計算が行われます。, where calculation is done when the user requests it.

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

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

プロパティ値

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

calculationState

アプリケーションの計算の状態を返します。Returns the calculation state of the application. 詳細については、Excel.CalculationState をご覧ください。See Excel.CalculationState for details. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

Excel.CalculationState | "Done" | "Calculating" | "Pending"

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

iterativeCalculation

反復計算の設定を返します。Returns the Iterative Calculation settings. Windows と Mac の Excel では、設定は Excel アプリケーションに適用されます。In Excel on Windows and Mac, the settings will apply to the Excel Application. Web 上の Excel およびその他のプラットフォームでは、設定は作業中のブックに適用されます。In Excel on the web and other platforms, the settings will apply to the active workbook.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly iterativeCalculation: Excel.IterativeCalculation;

プロパティ値

メソッドの詳細

calculate(calculationType)

Excel で現在開いているすべてのブックを再計算します。Recalculate all currently opened workbooks in Excel.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

calculate(calculationType: Excel.CalculationType): void;

パラメーター

calculationType
Excel.CalculationType

使用する計算の種類を指定します。Specifies the calculation type to use. 詳細については、「Excel の種類」を参照してください。See Excel.CalculationType for details.

戻り値

void

calculate(calculationTypeString)

Excel で現在開いているすべてのブックを再計算します。Recalculate all currently opened workbooks in Excel.

[API セット: excelapi 1.1][ API set: ExcelApi 1.1 ]

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

パラメーター

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

使用する計算の種類を指定します。Specifies the calculation type to use. 詳細については、「Excel の種類」を参照してください。See Excel.CalculationType for details.

戻り値

void

Examples

Excel.run(function (ctx) {
    ctx.workbook.application.calculate('Full');
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.Application-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.Application - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.Application-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.Application - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Application-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Application - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

Examples

Excel.run(function (ctx) {
    var application = ctx.workbook.application;
    application.load('calculationMode');
    return ctx.sync().then(function() {
        console.log(application.calculationMode);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.ApplicationUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.Application): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Application): void;

パラメーター

properties
Excel.Application

戻り値

void

suspendApiCalculationUntilNextSync()

次の "context.sync()" が呼び出されるまで、計算を中断します。設定されると、依存関係が確実に伝達されるようにブックを再計算するのは開発者の責任です。Suspends calculation until the next "context.sync()" is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

suspendApiCalculationUntilNextSync(): void;

戻り値

void

suspendScreenUpdatingUntilNextSync()

次の "context.sync()" が呼び出されるまで画面の更新を一時停止します。Suspends sceen updating until the next "context.sync()" is called.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

suspendScreenUpdatingUntilNextSync(): void;

戻り値

void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const rowCount = 500;
    const columnCount = 20;

    const startTime = Date.now();
    console.log("Starting...");

    if (pauseScreenPainting) {
        context.application.suspendScreenUpdatingUntilNextSync();
    }

    for (let i = 0; i < rowCount; i++) {
        for (let j = 0; j < columnCount; j++) {
            let cell = sheet.getCell(i, j);
            cell.values = [[i * j * Math.random()]];
            if (untrack) {
                cell.untrack();
            }
        }
    }

    await context.sync();

    console.log(`Ending. Adding ${rowCount * columnCount} cells took ${Date.now() - startTime} milliseconds`);
});

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel オブジェクトは API オブジェクトですが、このメソッドはtoJSON 、プレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.ApplicationData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Application object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ApplicationData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ApplicationData;

戻り値