Shell.UI.Dialog.js

Updated: August 24, 2015

Applies To: Windows Azure Pack

Displays the buttons on a dialog box.

Widgets

None.

None

None

Name	Description	Returns	Parameters
Shell.UI.Dialog.cancel	Called when the dialog wants to close following failure or no action.	Nothing	None
Shell.UI.Dialog.ok	Called when the dialog wants to close following success.	Nothing	None
Shell.UI.Dialog.open	Called to display a yes/no dialog.	Dialog	Config: Configuration object with the following fields: extension: Required. The name of the extension owning this dialog instance. name: The name of the dialog. Used to track telemetry data for the dialog. Template: Required. The name of the template to be rendered in the yesNo dialog. data: Optional. Data whose properties will be accessible as ${propertyName}. yes: Optional. Partner function to be called when user clicks on yes. no: Optional. Partner function to be called when user clicks on no. init: Optional. Partner function to be called after dialog template has been rendered. resizable: Optional. Defaults to false. Whether the user can resize the dialog. Draggable: Optional. Defaults to true. Whether the user can drag the dialog around the screen. width: Optional. Width of the dialog in standard units (px, em, etc) height: Optional. Height of the dialog in standard units (px, em, etc.) dataPolling: Optional. Allows data polling while the dialog is open. Defaults to false.

Shell.UI.Dialog.cancel

Called when the dialog wants to close following failure or no action.

Nothing

None

Shell.UI.Dialog.ok

Called when the dialog wants to close following success.

Nothing

None

Shell.UI.Dialog.open

Called to display a yes/no dialog.

Dialog

Config: Configuration object with the following fields:

extension: Required. The name of the extension owning this dialog instance.

name: The name of the dialog. Used to track telemetry data for the dialog.

Template: Required. The name of the template to be rendered in the yesNo dialog.

data: Optional. Data whose properties will be accessible as ${propertyName}.

yes: Optional. Partner function to be called when user clicks on yes.

no: Optional. Partner function to be called when user clicks on no.

init: Optional. Partner function to be called after dialog template has been rendered.

resizable: Optional. Defaults to false. Whether the user can resize the dialog.

Draggable: Optional. Defaults to true. Whether the user can drag the dialog around the screen.

width: Optional. Width of the dialog in standard units (px, em, etc)

height: Optional. Height of the dialog in standard units (px, em, etc.)

dataPolling: Optional. Allows data polling while the dialog is open. Defaults to false.