TabContext
TabContextは、ContextOpen、ContextCloseなどのタブ・レベルのイベントをリスニングし、FocusTabやCloseTabなどのタブ・レベルの操作を実行する機能を提供します。
サポートされているイベントは次のとおりです:
イベント名 | 説明 |
---|---|
ContextOpen | このイベントは、新しいオブジェクトが特定のタブで開かれるときに開始されます。 |
ContextClose | このイベントは、特定のタブでオブジェクトが閉じられると開始されます。 |
サポートされているアクションは次のとおりです:
処理名 | 説明 |
---|---|
FocusTab | このアクションは、特定のブラウザまたはMSIタブにフォーカスするために使用されます。 |
CloseTab | このアクションは、特定のブラウザまたはMSIタブを閉じるために使用されます。 |
TabContextの参照を取得するには、getTabContext関数を使用できます。 この関数は、アプリケーションがロードされるアクティブなタブへの参照を提供します。 また、特定のブラウザ・タブのコンテキストを取得するために、browserTabIdをオプション・パラメータとして渡すことができます。
構文は次のとおりです:
getTabContext(browserTabId?: string): Promise<ITabContext>;
パラメータは次のとおりです:
パラメータ名 | 必須かどうか | 説明 |
---|---|---|
browserTabId | No | 特定のブラウザ・タブのID。 ノート: 各ブラウザのtabIdを取得するには、各ブラウザ・タブからframeworkProviderのgetCurrentTabId APIをコールします。 |
次のコード・サンプルは、TypeScriptの例を示しています:
/// <reference path="uiEventsFramework.d.ts"/>
const frameworkProvider : IUiEventsFrameworkProvider = await
CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID');
const tabContext: ITabContext = await frameworkProvider.getTabContext();
次のコード・サンプルは、JavaScriptの例を示しています:
const frameworkProvider = await
CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID');
const tabContext = await frameworkProvider.getTabContext();