Wizard

WizardIcon Description

This node is used to create Wizard User Interfaces. A WebPanel that contains a "Wizard" node is the panel that is in charge of the wizard flow and navigation between the steps. Only one "Wizard" node is supported in a WebPanel. A "Wizard" node is composed of a series of "Steps" that are in charge of implementing a step of the wizard. For more information read Creating Wizard user interfaces

Runtime appearance

The "Wizard" node's runtime appearance depends greatly on the Wizard step node node it contains and the WizardBasicLayout.

WizardUI
Wizard UI

To change this default appearance, see Using Wizard Basic Layout Object.

Properties

Category Name Value
General Title The string to place as this section's title.
Icon Icon used to identify this component. By default it uses the K2BWizardIcon image. WizardIcon
Collapsible Determines if the component will be collapsible in runtime. See Collapsible property for details.
Start Collapsed Determines if the component will be collapsed by default in runtime.See Start collapsed property for details.
Description An optional description that can help the user to know what the wizard does. WizardDescription
SDT An SDT to temporarily store data which will be shared among steps and will be used when the wizard is completed. For more information read Defining a Wizard SDT
After Complete Panel A WebComponent that will be shown when the wizard is completed. For more information read After Complete in Wizards
After Complete Panel As New Step If Set to "True", the "After Complete Panel" will be shown as a new step in the "Wizard Progress Bar". For more information read After Complete in Wizards
Appearance Section Class Class of the Responsive Table containing the Wizard´s section.

User subroutines associated to this node

Name Moment of execution Detailed description and possible uses
U_WizardNext After the global event K2B_WizardNext when the next action is executed.

This subroutine is executed after the Next action is executed. This can be used to customize the "Next" action.

U_BeforeComplete Before the Wizard is completed.

This subroutine is executed when the "Finish" action is executed. This subroutine can be used to invalidate the wizard by setting the variable &IsValid_WizardMain to false if certain conditions are not met and also it can be used to add code to persist the result of the wizard in some data structure.

U_AfterComplete After the Wizard is completed.

This subroutine is fired when the wizard is completed. In this method the developer can choose, for example, to navigate to another panel, or to return to the caller.

U_LoadStep After loading the WebComponent of the current step.

This subroutine is executed after loading the WebComponent of the current step. This can be useful if the developer wants to add code after the WebComponent is loaded.

U_InitializeWizardSDT Before entering the Wizard.

This subroutine is executed before the first step is created. This can be useful if the developer needs to initialize the "Wizard SDT" before starting the Wizard. For more information read Creating Wizard user interfaces

Child nodes

  • AttributesIcon Attributes node. This node can be used to present information that does not change during the Wizard execution.
  • WizardStepsIcon Wizard steps node. This node represents the Steps of the Wizard.