Excel.Application class
ブックを管理する Excel アプリケーションを表します。
- Extends
注釈
[API セット: ExcelApi 1.1]
プロパティ
| 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
注釈
[API セット: ExcelApi 1.9]
calculationMode
Excel.CalculationMode
の定数で定義されている、ブックで使用される計算モードを返します。 指定可能な値は、 Automatic (Excel が再計算を制御します)、 AutomaticExceptTables (Excel が再計算を制御しますが、テーブルの変更を無視します)、 Manual (ユーザーの要求に応じて計算が行われます) です。 これはランタイム プロパティです。
calculationMode設定はブックに保持されません。
calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";
プロパティ値
Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"
注釈
[API セット: getはExcelApi 1.1、setは1.8]
calculationState
アプリケーションの計算の状態を返します。 詳細は「Excel.CalculationState」をご覧ください。
readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending";
プロパティ値
Excel.CalculationState | "Done" | "Calculating" | "Pending"
注釈
[API セット: ExcelApi 1.9]
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
cultureInfo
現在のシステム カルチャの設定に基づいた情報を提供します。 これには、カルチャ名、数値の書式設定、およびカルチャに依存するその他の設定が含まれます。
readonly cultureInfo: Excel.CultureInfo;
プロパティ値
注釈
[API セット: ExcelApi 1.11]
decimalSeparator
数値の小数点区切り文字として使用される文字列を取得します。 これは、ローカルの Excel の設定に基づいています。
readonly decimalSeparator: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.11]
iterativeCalculation
反復計算の設定を返します。 Windows および Mac の Excel では、設定は Excel アプリケーションに適用されます。 Excel on the web やその他のプラットフォームでは、設定がアクティブなブックに適用されます。
readonly iterativeCalculation: Excel.IterativeCalculation;
プロパティ値
注釈
[API セット: ExcelApi 1.9]
thousandsSeparator
数値の小数点以下以下を区切るために使用する文字列を取得します。 これは、ローカルの Excel の設定に基づいています。
readonly thousandsSeparator: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.11]
useSystemSeparators
Excel のシステム区切り記号を有効にするかどうかを指定します。 システム区切り記号には、小数点区切り記号と桁区切り記号が含まれます。
readonly useSystemSeparators: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.11]
メソッドの詳細
calculate(calculationType)
Excel で現在開いているすべてのブックを再計算します。
calculate(calculationType: Excel.CalculationType): void;
パラメーター
- calculationType
- Excel.CalculationType
使用する計算の種類を指定します。 詳細は「Excel.CalculationType」をご覧ください。
返品
void
注釈
[API セット: ExcelApi 1.1]
calculate(calculationType)
Excel で現在開いているすべてのブックを再計算します。
calculate(calculationType: "Recalculate" | "Full" | "FullRebuild"): void;
パラメーター
- calculationType
-
"Recalculate" | "Full" | "FullRebuild"
使用する計算の種類を指定します。 詳細は「Excel.CalculationType」をご覧ください。
返品
void
注釈
[API セット: ExcelApi 1.1]
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application;
パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Application;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
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
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.Application): void;
パラメーター
- properties
- Excel.Application
返品
void
suspendApiCalculationUntilNextSync()
次の context.sync() が呼び出されるまで計算を中断します。 設定されると、依存関係が確実に伝達されるようにブックを再計算するのは開発者の責任です。
suspendApiCalculationUntilNextSync(): void;
返品
void
注釈
[API セット: ExcelApi 1.6]
suspendScreenUpdatingUntilNextSync()
次の context.sync() が呼び出されるまで画面の更新を中断します。
注: 繰り返し (ループ内など) suspendScreenUpdatingUntilNextSync 呼び出さないでください。 呼び出しが繰り返されると、Excel ウィンドウがちらつきます。
suspendScreenUpdatingUntilNextSync(): void;
返品
void
注釈
[API セット: ExcelApi 1.9]
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Application オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ApplicationData と型指定) を返します。
toJSON(): Excel.Interfaces.ApplicationData;