IHostPageLayoutService interface

パッケージ:

azure-devops-extension-api

ページのレイアウトを操作するためのサービス: 全画面表示モードの管理、ダイアログとパネルの開き

プロパティ

openCustomDialog	ホスト フレームでダイアログを開き、カスタム外部コンテンツを表示する
openMessageDialog	ホスト フレームでダイアログを開き、指定したテキスト メッセージ、OK、およびオプションの [キャンセル] ボタンを表示します
openPanel	ホスト フレームでパネルを開き、カスタム外部コンテンツを表示する

メソッド

getFullScreenMode()	ページが現在全画面表示モードであるかどうかを取得します。
setFullScreenMode(boolean)	全画面表示モードを開始または終了する

プロパティの詳細

openCustomDialog

ホスト フレームでダイアログを開き、カスタム外部コンテンツを表示する

openCustomDialog: (contentContributionId: string, options?: IDialogOptions<TResult>) => void

プロパティ値

(contentContributionId: string, options?: IDialogOptions<TResult>) => void

openMessageDialog

ホスト フレームでダイアログを開き、指定したテキスト メッセージ、OK、およびオプションの [キャンセル] ボタンを表示します

openMessageDialog: (message: string, options?: IMessageDialogOptions) => void

プロパティ値

(message: string, options?: IMessageDialogOptions) => void

openPanel

ホスト フレームでパネルを開き、カスタム外部コンテンツを表示する

openPanel: (contentContributionId: string, options: IPanelOptions<TResult>) => void

プロパティ値

(contentContributionId: string, options: IPanelOptions<TResult>) => void

メソッドの詳細

getFullScreenMode()

ページが現在全画面表示モードであるかどうかを取得します。

function getFullScreenMode(): Promise<boolean>

戻り値

Promise<boolean>

setFullScreenMode(boolean)

全画面表示モードを開始または終了する

function setFullScreenMode(fullScreenMode: boolean)

パラメーター

fullScreenMode

boolean

全画面表示モードに入る場合は true、終了する場合は false。