IHostPageLayoutService interface

Package:

azure-devops-extension-api

Service for interacting with the layout of the page: managing full-screen mode, opening dialogs and panels

Properties

openCustomDialog	Open a dialog in the host frame, showing custom external content
openMessageDialog	Open a dialog in the host frame, showing the specified text message, an OK and optional Cancel button
openPanel	Open a panel in the host frame, showing custom external content

Methods

getFullScreenMode()	Gets whether the page is currently in full screen mode
setFullScreenMode(boolean)	Enter or exit full screen mode

Property Details

openCustomDialog

Open a dialog in the host frame, showing custom external content

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

Property Value

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

openMessageDialog

Open a dialog in the host frame, showing the specified text message, an OK and optional Cancel button

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

Property Value

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

openPanel

Open a panel in the host frame, showing custom external content

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

Property Value

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

Method Details

getFullScreenMode()

Gets whether the page is currently in full screen mode

function getFullScreenMode(): Promise<boolean>

Returns

Promise<boolean>

setFullScreenMode(boolean)

Enter or exit full screen mode

function setFullScreenMode(fullScreenMode: boolean)

Parameters

fullScreenMode

boolean

True to enter full-screen mode, false to exit.