IHostPageLayoutService interface

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

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

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

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

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

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

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

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

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

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

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

Gets whether the page is currently in full screen mode

function getFullScreenMode(): Promise<boolean>

Promise<boolean>

Enter or exit full screen mode

function setFullScreenMode(fullScreenMode: boolean)

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