Wizard Classes

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

When you create a new wizard using the How to: Create Wizards, the wizard class will have the same name as your wizard.

Depending on the type of wizard, your wizard class extends either the SysWizard class, or the SysDefaultDataWizard class.

Useful methods on the SysWizard class

Method	Description
validate	Used to validate user input, and called before the wizard is closed. It returns false if user input is invalid. This will prevent the run method from being called when the user clicks the Finish button.
formRun	Returns a formRun, which is an instance of the form of the same name as the class. This method is always overridden but should not be changed.
static void main(args args)	Creates a new instance of the wizard and calls wizard.run on the SysWizard class. This method is always overridden, but should not be changed.
run	Called when the user clicks the Finish button if validate returned true.
setupNavigation	Use this method to set up whether the Next and Back buttons should be enabled from the start. All Back and Next buttons are enabled by default, except for the Back button in the first step and the Next button in the last step.
skipTab	Allows you to skip a tab page when certain conditions are met.

Useful methods on the SysDefaultDataWizard class

Method	Description
enabled	Determines whether the wizard should be displayed in the list of basic setup wizards.
mustRun	Determines if base data exists or if it should be created by the wizard.
description	Returns a short description of what the wizard does. The description is used in the wizard's caption if the Caption property has not been set.

See also

Creating a wizard

Wizards in Microsoft Dynamics AX

Enabling Wizard Buttons Depending on User Input

Announcements: New book: "Inside Microsoft Dynamics AX 2012 R3" now available. Get your copy at the MS Press Store.