Excel.Application class
ブックを管理する Excel アプリケーションを表します。
- Extends
注釈
プロパティ
| calculation |
最後の完全な再計算に使用した Excel 計算エンジンのバージョンを返します。 |
| calculation |
|
| calculation |
アプリケーションの計算の状態を返します。 詳細は「 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| culture |
現在のシステム カルチャ設定に基づいて情報を提供します。 これには、カルチャ名、数値の書式設定、およびその他のカルチャに依存する設定が含まれます。 |
| decimal |
数値の小数点として使用される文字列を取得します。 これは、ローカルの Excel 設定に基づいています。 |
| iterative |
反復計算設定を返します。 Windows および Mac 上の Excel では、設定が Excel アプリケーションに適用されます。 Excel on the webやその他のプラットフォームでは、設定がアクティブなブックに適用されます。 |
| thousands |
数値の小数点の左側にある数字のグループを区切るために使用される文字列を取得します。 これは、ローカルの Excel 設定に基づいています。 |
| use |
Excel のシステム区切り記号を有効にするかどうかを指定します。 システム区切り記号には、小数点と桁区切り記号が含まれます。 |
メソッド
| calculate(calculation |
Excel で現在開いているすべてのブックを再計算します。 |
| calculate(calculation |
Excel で現在開いているすべてのブックを再計算します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| suspend |
次の |
| suspend |
次の
注*: |
| toJSON() | API オブジェクトが |
プロパティの詳細
calculationEngineVersion
最後の完全な再計算に使用した Excel 計算エンジンのバージョンを返します。
readonly calculationEngineVersion: number;プロパティ値
number
注釈
calculationMode
Excel.CalculationMode
の定数で定義されているブックで使用される計算モードを返します。 使用可能な値は、 Automaticです。Excel は再計算を制御します。 AutomaticExceptTables、Excel は再計算を制御しますが、テーブルの変更は無視します。 Manualは、ユーザーが要求したときに計算が実行されます。
calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";プロパティ値
Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"
注釈
calculationState
アプリケーションの計算の状態を返します。 詳細は「Excel.CalculationState」をご覧ください。
readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending";プロパティ値
Excel.CalculationState | "Done" | "Calculating" | "Pending"
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
cultureInfo
現在のシステム カルチャ設定に基づいて情報を提供します。 これには、カルチャ名、数値の書式設定、およびその他のカルチャに依存する設定が含まれます。
readonly cultureInfo: Excel.CultureInfo;プロパティ値
注釈
decimalSeparator
数値の小数点として使用される文字列を取得します。 これは、ローカルの Excel 設定に基づいています。
readonly decimalSeparator: string;プロパティ値
string
注釈
例
// 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();
});
iterativeCalculation
反復計算設定を返します。 Windows および Mac 上の Excel では、設定が Excel アプリケーションに適用されます。 Excel on the webやその他のプラットフォームでは、設定がアクティブなブックに適用されます。
readonly iterativeCalculation: Excel.IterativeCalculation;プロパティ値
注釈
thousandsSeparator
数値の小数点の左側にある数字のグループを区切るために使用される文字列を取得します。 これは、ローカルの Excel 設定に基づいています。
readonly thousandsSeparator: string;プロパティ値
string
注釈
useSystemSeparators
Excel のシステム区切り記号を有効にするかどうかを指定します。 システム区切り記号には、小数点と桁区切り記号が含まれます。
readonly useSystemSeparators: boolean;プロパティ値
boolean
注釈
メソッドの詳細
calculate(calculationType)
Excel で現在開いているすべてのブックを再計算します。
calculate(calculationType: Excel.CalculationType): void;パラメーター
- calculationType
- Excel.CalculationType
使用する計算の種類を指定します。 詳細は「Excel.CalculationType」をご覧ください。
戻り値
void
注釈
例
// 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
注釈
例
await Excel.run(async (context) => {
context.workbook.application.calculate('Full');
await context.sync();
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Application;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
await Excel.run(async (context) => {
const application = context.workbook.application;
application.load('calculationMode');
await context.sync();
console.log(application.calculationMode);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Application;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
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
suspendApiCalculationUntilNextSync()
次の context.sync() が呼び出されるまで計算を中断します。 設定されると、依存関係が確実に伝達されるようにブックを再計算するのは開発者の責任です。
suspendApiCalculationUntilNextSync(): void;戻り値
void
注釈
suspendScreenUpdatingUntilNextSync()
次の context.sync() が呼び出されるまで、画面の更新を中断します。
注*: suspendScreenUpdatingUntilNextSync を繰り返し呼び出さないでください (ループなど)。 呼び出しを繰り返すと、Excel ウィンドウがちらつきになります。
suspendScreenUpdatingUntilNextSync(): void;戻り値
void
注釈
例
// 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://learn.microsoft.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`);
});
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Application オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ApplicationData として型指定) を返します。
toJSON(): Excel.Interfaces.ApplicationData;戻り値
Office Add-ins