C# Class Habanero.Faces.Win.WizardFormWin

Represents a form containing a wizard control that guides users through a process step by step. This form simply wraps the WizardControl in a form and handles communication with the user.

Inheritance: FormWin, IWizardForm

Show file Open project: Chillisoft/habanero.faces Class Usage Examples

Private Properties

Property	Type	Description
CancelButton_OnClick	void
InitializeComponent	void
SetupWizardControl	void
Show	bool
WizardControl_Finished	void
WizardControl_MessagePosted	void
WizardControl_StepChanged	void
WizardFormWin_Closing	void

Public Methods

Method	Description
Refresh ( ) : void	Forces the form to invalidate its client area and immediately redraw itself and any child controls
Show ( string title, IWizardController wizardController, IControlFactory controlFactory ) : void	A convenience method to show a wizard using a particular title and wizard controller
ShowDialog ( string title, IWizardController wizardController, IControlFactory controlFactory ) : bool	A convenience method to show a wizard using a particular title and wizard controller in a dialog
WizardFormWin ( IWizardController controller ) : System	Initialises the WizardForm, sets the controller and starts the wizard.
WizardFormWin ( IWizardController controller, IControlFactory controlFactory ) : System	Initialises the WizardForm, sets the controller and starts the wizard.
WizardFormWin ( WizardControlWin control ) : System	Initialises the WizardForm, sets the controller and starts the wizard.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.

Private Methods

Method	Description
CancelButton_OnClick ( object sender, EventArgs e ) : void
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
SetupWizardControl ( WizardControlWin control ) : void
Show ( string title, IWizardController wizardController, bool showDialog, IControlFactory controlFactory ) : bool
WizardControl_Finished ( object sender, EventArgs e ) : void
WizardControl_MessagePosted ( string message ) : void
WizardControl_StepChanged ( IWizardStep obj ) : void
WizardFormWin_Closing ( object sender, System e ) : void

Method Details

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	true if managed resources should be disposed; otherwise, false.
return	void

Refresh() public method

Forces the form to invalidate its client area and immediately redraw itself and any child controls

public Refresh ( ) : void
return	void

Show() public static method

A convenience method to show a wizard using a particular title and wizard controller

public static Show ( string title, IWizardController wizardController, IControlFactory controlFactory ) : void
title	string	The title of the wizard, displayed in the title bar of the form
wizardController	IWizardController	The wizard controller
controlFactory	IControlFactory	the factory used to create the controls on the wizard
return	void

ShowDialog() public static method

A convenience method to show a wizard using a particular title and wizard controller in a dialog

public static ShowDialog ( string title, IWizardController wizardController, IControlFactory controlFactory ) : bool
title	string	The title of the wizard, displayed in the title bar of the form
wizardController	IWizardController	The wizard controller
controlFactory	IControlFactory	the factory used to create the controls on the wizard
return	bool

WizardFormWin() public method

Initialises the WizardForm, sets the controller and starts the wizard.

public WizardFormWin ( IWizardController controller ) : System
controller	IWizardController	the wizrd controller that controls moving the wizard steps and the
return	System

WizardFormWin() public method

Initialises the WizardForm, sets the controller and starts the wizard.

public WizardFormWin ( IWizardController controller, IControlFactory controlFactory ) : System
controller	IWizardController	the wizrd controller that controls moving the wizard steps and the
controlFactory	IControlFactory	The control factory to use for creating any controls
return	System

WizardFormWin() public method

Initialises the WizardForm, sets the controller and starts the wizard.

public WizardFormWin ( WizardControlWin control ) : System
control	WizardControlWin	The WizardControl that this form is showing.
return	System