Shell.UI.Dialogs.Dialog.js
Applies To: Windows Azure Pack
Provides methods used to create a modal dialog box on the page.
Widgets
None.
Types
Shell.UI.Dialogs.Dialog(title, url)
Configures a new Dialog.
Name |
Type |
Description |
|---|---|---|
title |
String |
The Dialog title. |
url |
String |
The dialog URL. |
Properties
None.
Methods
Name |
Description |
Returns |
Parameters |
|---|---|---|---|
Shell.UI.Dialogs.Dialog.activate |
Associates a callback when the step is activated. |
Nothing |
callback (Function): The callback. |
Shell.UI.Dialogs.Dialog.closing |
Sets the closing callback event. This event is cancellable by returning false. |
Nothing |
callback (Function): The callback. |
Shell.UI.Dialogs.Dialog.deactivate |
Associates a callback when the step is deactivated. This event is cancellable by returning false. |
Nothing |
callback (Function): The callback. |
Shell.UI.Dialogs.Dialog.error |
Sets the error callback event. |
Nothing |
callback (Function): The callback. |
Shell.UI.Dialogs.getThisDialog |
If called from within an iframe loaded by the wizard this will return a WizardStep object that can be used to communicate with the framework. |
wizardStep object |
None. |
Shell.UI.Dialogs.Dialog.open |
Opens the dialog. |
Nothing |
None |
Shell.UI.Dialogs.Dialog.ready |
Indicates the server the dialog is ready to navigate onto. |
Nothing |
None |
Shell.UI.Dialogs.Dialog.setCompleteButtonEnabled |
Enables or disables the complete button. |
Nothing |
completeButtonEnabled (Boolean): Enables the complete button. |
Shell.UI.Dialogs.Dialog.setData |
Sets the data associated with this dialog to a new value. |
Nothing |
data (Object): The dialog data. |
Shell.UI.Dialogs.Dialog.setSize |
Sets the size. |
Nothing |
width (Number): Width in pixels. height (Number): Height in pixels. |
Shell.UI.Dialogs.Dialog.setTitle |
Sets the title. |
Nothing |
title (String): The title. |
Shell.UI.Dialogs.Dialog.showProgress |
Shows the progress. |
Nothing |
showProgress (Boolean): Shows the progress if true. |