C# Class CK.WPF.Wizard.WizardPage

This class is used to fill the WizardManager's stack. It has all the properties needed by the WizardManager to display a wizard with next and back actions.
Inheritance: PropertyChangedBase, IWizardNavigable
Show file Open project: Invenietis/ck-certified Class Usage Examples

Public Properties

Property Type Description
WizardManager WizardManager

Private Properties

Property Type Description
WizardPage System

Public Methods

Method Description
CheckCanGoBack ( ) : bool

Is called before going to the previous step of the wizard. Can be overridden to implement the test corresponding to the situation.

CheckCanGoFurther ( ) : bool

Is called before going to the next step of the wizard. Can be overridden to implement the test corresponding to the situation.

OnActivated ( ) : void

Is called after ActivateItem function.

OnActivating ( ) : bool

Is called before ActivateItem function.

OnBeforeGoBack ( ) : bool

Is called right before going ot the previous step, but after checking CanGoBack. Can be overridden to do something before changing the ActiveItem. Return false to cancel going ot the previous WizardPage

OnBeforeNext ( ) : bool

Is called right before going ot the next step, but after checking CanGoFurther. Can be overridden to do something before changing the ActiveItem. Return false to cancel going ot the next WizardPage

RaiseActivated ( WizardNavigableEventArgs e ) : void
RaiseActivating ( CancelEventArgs e ) : void
WizardPage ( WizardManager wizardManager, WizardPage next, string title = "" ) : System

This constructor specifies a next wizard. Its "IsLastStep" Property is autmatically set to false.

WizardPage ( WizardManager wizardManager, bool isLastStep, string title = "" ) : System

This constructor doesn't specify a next wizard page (you can do it directly in the WizardPage). You should therefor specify if it is the last step of the wizard or not.

Private Methods

Method Description
WizardPage ( WizardManager wizardManager, WizardPage next, bool isLastStep, string title = "" ) : System

Method Details

CheckCanGoBack() public method

Is called before going to the previous step of the wizard. Can be overridden to implement the test corresponding to the situation.
public CheckCanGoBack ( ) : bool
return bool

CheckCanGoFurther() public method

Is called before going to the next step of the wizard. Can be overridden to implement the test corresponding to the situation.
public CheckCanGoFurther ( ) : bool
return bool

OnActivated() public method

Is called after ActivateItem function.
public OnActivated ( ) : void
return void

OnActivating() public method

Is called before ActivateItem function.
public OnActivating ( ) : bool
return bool

OnBeforeGoBack() public method

Is called right before going ot the previous step, but after checking CanGoBack. Can be overridden to do something before changing the ActiveItem. Return false to cancel going ot the previous WizardPage
public OnBeforeGoBack ( ) : bool
return bool

OnBeforeNext() public method

Is called right before going ot the next step, but after checking CanGoFurther. Can be overridden to do something before changing the ActiveItem. Return false to cancel going ot the next WizardPage
public OnBeforeNext ( ) : bool
return bool

RaiseActivated() public method

public RaiseActivated ( WizardNavigableEventArgs e ) : void
e WizardNavigableEventArgs
return void

RaiseActivating() public method

public RaiseActivating ( CancelEventArgs e ) : void
e CancelEventArgs
return void

WizardPage() public method

This constructor specifies a next wizard. Its "IsLastStep" Property is autmatically set to false.
public WizardPage ( WizardManager wizardManager, WizardPage next, string title = "" ) : System
wizardManager WizardManager The WizardManager
next WizardPage The next WizardPage
title string (optional) title of the page
return System

WizardPage() public method

This constructor doesn't specify a next wizard page (you can do it directly in the WizardPage). You should therefor specify if it is the last step of the wizard or not.
public WizardPage ( WizardManager wizardManager, bool isLastStep, string title = "" ) : System
wizardManager WizardManager The WizardManager
isLastStep bool Whether this step is the last of the wizard
title string (optional) title of the page
return System

Property Details

WizardManager public property

Gets the WizardManager that holds this step (this WizardPage).
public WizardManager WizardManager
return WizardManager