OfficeExtension.ClientRequestContext class
Office アプリケーションへの要求を容易にする抽象 RequestContext オブジェクト。
Excel.run メソッドと Word.run メソッドは、要求コンテキストを提供します。
コンストラクター
| (constructor)(url) |
|
プロパティ
| debug |
デバッグ情報 |
| request |
要求ヘッダー |
| tracked |
ドキュメント内の周囲の変更に基づいて自動調整のために追跡されるオブジェクトのコレクション。 |
メソッド
| load(object, option) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load |
コマンドをキューに入れ、オブジェクトとそのナビゲーション プロパティの指定されたプロパティを再帰的に読み込みます。 プロパティを読み取る前に、 |
| sync(pass |
JavaScript プロキシ オブジェクトと Office ドキュメントの間で状態を同期します。要求コンテキストでキューに登録された命令を実行し、コードで使用するために読み込まれた Office オブジェクトのプロパティを取得します。 このメソッドは、同期が完了したときに解決される promise を返します。 |
| trace(message) | キューにトレース メッセージを追加します。 エラーが原因で |
コンストラクターの詳細
(constructor)(url)
ClientRequestContext クラスの新しいインスタンスを構築します
constructor(url?: string);パラメーター
- url
-
string
プロパティの詳細
debugInfo
requestHeaders
要求ヘッダー
requestHeaders: { [name: string]: string };プロパティ値
{ [name: string]: string }
trackedObjects
ドキュメント内の周囲の変更に基づいて自動調整のために追跡されるオブジェクトのコレクション。
trackedObjects: TrackedObjects;プロパティ値
メソッドの詳細
load(object, option)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(object: ClientObject, option?: string | string[] | LoadOption): void;パラメーター
- object
- OfficeExtension.ClientObject
プロパティが読み込まれるオブジェクト。
- option
-
string | string[] | OfficeExtension.LoadOption
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列、または OfficeExtension.LoadOption オブジェクト。
戻り値
void
loadRecursive(object, options, maxDepth)
コマンドをキューに入れ、オブジェクトとそのナビゲーション プロパティの指定されたプロパティを再帰的に読み込みます。
プロパティを読み取る前に、context.sync() を呼び出す必要があります。
loadRecursive(object: ClientObject, options: { [typeName: string]: string | string[] | LoadOption }, maxDepth?: number): void;パラメーター
- object
- OfficeExtension.ClientObject
読み込むオブジェクト。
- options
-
{ [typeName: string]: string | string[] | OfficeExtension.LoadOption }
型の読み込みオプションのキーと値のペアリング (例: { "Workbook": "worksheets,tables", "Worksheet": "tables", "Tables": "name" }
- maxDepth
-
number
最大再帰深さ。
戻り値
void
sync(passThroughValue)
JavaScript プロキシ オブジェクトと Office ドキュメントの間で状態を同期します。要求コンテキストでキューに登録された命令を実行し、コードで使用するために読み込まれた Office オブジェクトのプロパティを取得します。 このメソッドは、同期が完了したときに解決される promise を返します。
sync<T>(passThroughValue?: T): Promise<T>;パラメーター
- passThroughValue
-
T
戻り値
Promise<T>
trace(message)
キューにトレース メッセージを追加します。 エラーが原因で context.sync() から返された promise が拒否された場合、実行されたすべてのトレース メッセージを含む ".traceMessages" 配列が OfficeExtension.Error オブジェクトに追加されます。 これらのメッセージは、プログラムの実行シーケンスを監視し、エラーの原因を検出するのに役立ちます。
trace(message: string): void;パラメーター
- message
-
string
戻り値
void
Office Add-ins