Page Events
- 2 minutes to read
This help topic describes the sequence of events raised when an end-user navigates between wizard pages.
Forward Navigation
- WizardControl.NextClick - Fires when the Next button is clicked. Allows you to cancel the operation or navigate to a custom page.
-
If the operation has not been canceled within the NextClick event handler, the PageValidating event is raised. This event occurs when the page is about to be switched, and allows you to specify whether or not its data is valid. If page data is invalid, an error message is displayed. The page cannot be switched until it is valid.
WizardControl.SelectedPageChanging - Enables you to control whether a wizard page can be selected. You can handle this event to do the following:
- cancel the operation;
- Initialize the settings of the newly selected wizard page;
- implement conditional navigation.
BaseWizardPage.PageCommit - Enables you to persist the changes made within the current step.
If the operation was not canceled and the current page has been switched, the PageCommit event is raised. It allows you to save the changes made in this step (if required).
The PageCommit event is also raised after an end-user has clicked the Finish button.
- BaseWizardPage.PageInit - Fires when the current BaseWizardPage is about to be displayed and allows you to initialize the content of this page.
- WizardControl.SelectedPageChanged - Fires after the current wizard page has been changed.
Backward Navigation
- WizardControl.PrevClick - Fires after the Back button has been clicked and allows you to cancel the operation.
- BaseWizardPage.PageValidating - Enables you to specify whether page data is valid, and whether the page can be switched.
- WizardControl.SelectedPageChanging - Enables you to control whether a wizard page can be selected.
BaseWizardPage.PageRollback - Enables you to rollback the current step.
If the operation was not canceled and the current page has been switched, the PageRollback event is raised. It allows you to roll back (reset) the changes made in this step (if required).
If the Cancel button has been clicked, the PageRollback event is raised for each wizard page visited.
- BaseWizardPage.PageInit - Fires when the current BaseWizardPage is about to be displayed and allows you to initialize the content of this page.
- WizardControl.SelectedPageChanged - Fires after the current wizard page has been changed.