Shell.UI.Dialogs.Wizard.js
Applies To: Windows Azure Pack
Provides methods to build and create a wizard on the page.
Wizards contain steps that the user can follow in order to accomplish a complex task. This topic provides information about Wizards and Wizard Steps.
Widgets
None.
Types
Shell.UI.Dialogs.Wizard(title)
Name |
Type |
Description |
title |
String |
The wizard title. |
Shell.UI.Dialogs.WizardStep(url,index,options)
To create a wizard step, use the Wizard addStep method to add a WizardStep object to a Wizard.
Properties
None.
Methods – Wizard
Name |
Description |
Returns |
Parameters |
|---|---|---|---|
Shell.UI.Dialogs.Wizard.addStep |
Adds a step to the current wizard. |
Shell.UI.Dialogs.WizardStep |
index (Number): Index of the step, if not provided, adds at the end. title (String): Title of the wizard step. url (String): Url of the wizard step. |
Shell.UI.Dialogs.Wizard.closing |
Sets the closing callback event. This event is cancellable by returning false. |
Nothing |
callback (Function): The callback. |
Shell.UI.Dialogs.Wizard.error |
Sets the error callback event. |
Nothing |
callback (Function): The callback. |
Shell.UI.Dialogs.Wizard.getSteps |
Gets the wizard steps. |
Wizard Steps Array |
None |
Shell.UI.Dialogs.getThisWizardStep |
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 |
None |
Shell.UI.Dialogs.Wizard.open |
Opens the wizard. |
Nothing |
None |
Shell.UI.Dialogs.Wizard.removeStep |
Removes a step to the current wizard. |
Nothing |
wizardStep (Shell.UI.Dialogs.WizardStep): The step. |
Shell.UI.Dialogs.Wizard.setAutoLock |
Sets the autoLock. |
Nothing |
autoLock (String): The autoLock. |
Shell.UI.Dialogs.Wizard.setCompleteButtonEnabled |
Enables or disables the complete button. |
Nothing |
enable (String): Enables. |
Shell.UI.Dialogs.Wizard.setData |
Sets the data associated with this wizard to a new value. |
Nothing |
data (Object): The wizard data. |
Shell.UI.Dialogs.Wizard.setSize |
Sets the size. |
Nothing |
width (Number): Width in pixel. height (Number): Height in pixel. |
Shell.UI.Dialogs.Wizard.setTitle |
Sets the title. |
Nothing |
title (String): The title. |
Shell.UI.Dialogs.Wizard.showProgress |
Shows the progress. |
Nothing |
autoLock (String): Shows the progress if true. |
Methods - WizardStep
Name |
Description |
Returns |
Parameters |
|---|---|---|---|
setTitle |
Sets the wizrd step title. |
Nothing |
Title (String): The wizrd step title. |
setUrl |
Sets the wizard step URL. |
Nothing. |
url (String): The wizard step URL. |
setLocked |
Sets the locked |
Nothing |
Locked (String): The locked wizard step. |
activate |
Associates a callback when the step is deactivated. |
Nothing. |
Callback (Function): the callback function to associate. |
deactivate |
Associates a callback when the step is deactivated. |
Nothing. |
Callback (Function): The callback function. |
movePrevious |
Associates a callback when the step is going backwards. |
Nothing. |
Callback (Function): The callback function. |
moveNext |
Associates a callback when the step is going forwards. |
Nothing. |
Callback (Function): The callback function. |
ready |
Indicates the step is ready to navigate. |
Nothing. |
None |
enableNextButton |
Enables the next button for this wizard step. |
Nothing. |
None. |
disableNextButton |
Disables the next button for this wizard step. |
Nothing. |
None. |
getWizard |
Returns the wizard associated with this wizard step. |
Object (Wizard). |
None. |
setWizardData |
Sets the data associated with this wizrd to a new value. |
Nothing. |
Data (Object): The wizard data. |