OfficeExtension.ClientRequestContext class
Office アプリケーションへの要求を容易にする抽象的な RequestContext オブジェクト。
Excel.run メソッドと Word.run メソッドは、要求コンテキストを提供します。
注釈
使用元
- Excel: 実行
- Excel.CustomFunctionManager: newObject
- Excel.DocumentTaskChange: newObject
- OfficeExtension.ClientObject: context
- OfficeExtension.EventHandlerResult: context
- OfficeExtension.RunOptions: previousObjects
- PowerPoint.Application: newObject
- PowerPoint.SensitivityLabelsCatalog: newObject
- Visio: 実行
- Word.アプリケーション: newObject
- Word.SearchOptions: newObject
- Word.SensitivityLabelsCatalog: newObject
コンストラクター
| (constructor)(url) |
|
プロパティ
| debug |
デバッグ情報 |
| request |
要求ヘッダー |
| tracked |
ドキュメント内の周囲の変化に基づいて自動調整のために追跡されるオブジェクトのコレクション。 |
メソッド
| load(object, option) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load |
オブジェクトとそのナビゲーション プロパティの指定されたプロパティを再帰的に読み込むコマンドをキューに入れます。 プロパティを読み取る前に、 |
| sync(pass |
要求コンテキストでキューに登録された命令を実行し、コードで使用するために読み込まれた Office オブジェクトのプロパティを取得することで、JavaScript プロキシ オブジェクトと 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)
要求コンテキストでキューに登録された命令を実行し、コードで使用するために読み込まれた Office オブジェクトのプロパティを取得することで、JavaScript プロキシ オブジェクトと 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