C# Class Habanero.Faces.Win.WizardStepWin

A basic implementation of WizardStep that can be used for simply displaying a message. Should a step be required that is a simple message for the user (such as at the end of a wizard), this step can be used

Inheritance: UserControlWin, IWizardStep

Show file Open project: Chillisoft/habanero.faces

Public Methods

Method	Description
CanCancel ( ) : bool	Can the user cancel from this wizard step. I.e. the objects under the control of this step have not been moved into a state that prohibits cancelling all changes. It is very rare that you would not be able to cancel at any point in a wizard.
CanFinish ( ) : bool	Can the user select finish from this wizard step. I.e. is sufficient information captured so that all information gathered in future steps can be set to defaults.
CanMoveBack ( ) : bool	Verifies whether the user can move back from this step.
CanMoveOn ( string &message ) : bool	Always returns true as this wizard step is simply for displaying a message to a user.
CancelStep ( ) : void	Provides an interface for the developer to implement functionality to cancel all edits made as part of this wizard step. The default wizard controller functionality is to call all wizard steps cancelStep methods when its Cancel method is called on the Wizard Controller (i.e. typically when Cancel Button is selected.
InitialiseStep ( ) : void	Initialises the step. Run when the step is reached.
MoveOn ( ) : void	Does any actions involved in this wizard step when you move on to the next wizard step. E.g. Updates any Objects from User interface controls.
UndoMoveOn ( ) : void	Undoes any actions that have been done by this wizard step. Usually you would want this to do nothing since if the user does a previous and then next they would not expect to lose their. But in some cases you may have created objects based on the selection in this step and when you move back to this step you want to these so that if the user changes his/her selection then new objects or different objects are created.
WizardStepWin ( ) : System	Constructs the MessageWizardStep

Protected Methods

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

Private Methods

Method	Description
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.

Method Details

CanCancel() public method

Can the user cancel from this wizard step. I.e. the objects under the control of this step have not been moved into a state that prohibits cancelling all changes. It is very rare that you would not be able to cancel at any point in a wizard.

public CanCancel ( ) : bool
return	bool

CanFinish() public method

Can the user select finish from this wizard step. I.e. is sufficient information captured so that all information gathered in future steps can be set to defaults.

public CanFinish ( ) : bool
return	bool

CanMoveBack() public method

Verifies whether the user can move back from this step.

public CanMoveBack ( ) : bool
return	bool

CanMoveOn() public method

Always returns true as this wizard step is simply for displaying a message to a user.

public CanMoveOn ( string &message ) : bool
message	string	Out parameter that will always be the empty string
return	bool

CancelStep() public method

Provides an interface for the developer to implement functionality to cancel all edits made as part of this wizard step. The default wizard controller functionality is to call all wizard steps cancelStep methods when its Cancel method is called on the Wizard Controller (i.e. typically when Cancel Button is selected.

public CancelStep ( ) : void
return	void

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

InitialiseStep() public method

Initialises the step. Run when the step is reached.

public InitialiseStep ( ) : void
return	void

MoveOn() public method

Does any actions involved in this wizard step when you move on to the next wizard step. E.g. Updates any Objects from User interface controls.

public MoveOn ( ) : void
return	void

UndoMoveOn() public method

Undoes any actions that have been done by this wizard step. Usually you would want this to do nothing since if the user does a previous and then next they would not expect to lose their. But in some cases you may have created objects based on the selection in this step and when you move back to this step you want to these so that if the user changes his/her selection then new objects or different objects are created.

public UndoMoveOn ( ) : void
return	void

WizardStepWin() public method

Constructs the MessageWizardStep

public WizardStepWin ( ) : System
return	System