Using Wizard Basic Layout Object.

Objective

There are cases in which developers want to change the disposition of elements inside a Wizard. For this purpose the Wizard has a default layout that can be modified by the user. Using this object the developer can change the user interface of all Wizards. The developer can also create a copy of the object to change how some wizards are generated.

How it works

In K2BWebPanelDesignerSettings there is a property named "Wizard Main Layout Object". Its default value is "WizardBasicLayoutOrion". You can edit the "WizardBasicLayoutOrion" object or create a new web panel and set it as the "Wizard Main Layout Object".

WizardBasicLayout
WizardBasicLayoutObject

Customizing the Layout Object

In order to customize the layout object, you must know the contents of the web panel according to the control names and control type.

These are the controls that must be included in the layout object.

Component Type Control Name Usage
Textblock Attributes It will be replaced by the Attributes node inside the Wizard
Textblock Description It will be replaced by the "Description" property of the "Wizard" node.
UCWeb K2BWizardSteps The user control for the wizard will be placed there. By default the K2BWizardSteps UC will be used. The developer can change it to use other user control. It must keep the "K2BWizardSteps" control name, and the User Control must have the properties WizardSteps, SelectedStep and CurrentStep.
Textblock WizardStepComponent Will be replaced for a WebComponent in which the WebPanel that implements the step will be shown.
Button Previous Will be replaced by the Previous action. Class and caption properties will be maintained.
Button Next Will be replaced by the Next action. Class and caption properties will be maintained.
Button Finish Will be replaced by the Finish action. Class and caption properties will be maintained.
Button Cancel Optional. If the Wizard Basic Layout contains a cancel button, it will be replaced by a Cancel action. The Cancel action will be generated (it will return to the caller object). Class and caption properties will be maintained. The Cancel Button is not present in the default Wizard Basic Layout.

Events in Wizard Basic Layout object

Events can be added to the WizardBasicLayout. Also the subroutine 'GoToStep' can be called. If it is called in the events part, it will be replaced by the 'GoToStep' subroutine of the generated panel. The 'GoToStep' subroutine is in charge of loading the Step related with the value of the &StepNumber variable. The &StepNumber variable is binded to the SelectedStep property of the Wizard User Control.