Class Wizard

The base class for wizard-like controls.

Inheritance
System.Object
Wizard
WizardControl
XPTaskPane
Implements
System.ComponentModel.ISupportInitialize
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class Wizard : UserControl, ISupportInitialize

Constructors

Wizard()

Declaration
public Wizard()

Fields

wizardPgs

Declaration
protected WizardPage[] wizardPgs
Field Value
Type
WizardPage[]

Properties

CardLayout

Gets the CardLayout component used to switch between the pages.

Declaration
public CardLayout CardLayout { get; }
Property Value
Type
CardLayout

DesignerHost

Gets the Designer Host.

Declaration
protected IDesignerHost DesignerHost { get; }
Property Value
Type
System.ComponentModel.Design.IDesignerHost

PageContainer

Gets the Panel based class that holds the pages.

Declaration
public WizardContainer PageContainer { get; }
Property Value
Type
WizardContainer

SelectedPage

Gets or sets the selected page.

Declaration
public virtual WizardPage SelectedPage { get; set; }
Property Value
Type
WizardPage

WizardPages

Gets or sets the array that holds the pages.

Declaration
public virtual WizardPage[] WizardPages { get; set; }
Property Value
Type
WizardPage[]

Methods

add_AfterPageSelect(Wizard.WizardPageSelectEventHandler)

Declaration
public void add_AfterPageSelect(Wizard.WizardPageSelectEventHandler value)
Parameters
Type Name Description
Wizard.WizardPageSelectEventHandler value

add_BeforePageSelect(Wizard.WizardPageSelectEventHandler)

Declaration
public void add_BeforePageSelect(Wizard.WizardPageSelectEventHandler value)
Parameters
Type Name Description
Wizard.WizardPageSelectEventHandler value

AddPage(WizardPage)

Adds the specified page to the wizard.

Declaration
public void AddPage(WizardPage page)
Parameters
Type Name Description
WizardPage page

The WizardPage to add.

Dispose(Boolean)

Cleans up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Bool disposing

EndInit()

Called by the designer when the control is created for the first time.

Declaration
public void EndInit()

GetIsMirrored()

Declaration
protected bool GetIsMirrored()
Returns
Type
System.Boolean

InitDesignerHostRef()

Declaration
protected void InitDesignerHostRef()

NextPage()

Selects the next page.

Declaration
public void NextPage()

OnAfterPageSelect(WizardPageSelectEventArgs)

Called when AfterPageSelect event is fired

Declaration
protected void OnAfterPageSelect(WizardPageSelectEventArgs e)
Parameters
Type Name Description
WizardPageSelectEventArgs e

EventArgs that contains the event data.

OnBack(EventArgs)

Called when Back event is fired

Declaration
protected void OnBack(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs that contains the event data.

OnBeforePageSelect(WizardPageSelectEventArgs)

Called when OnBeforePageSelect event is fired

Declaration
protected void OnBeforePageSelect(WizardPageSelectEventArgs e)
Parameters
Type Name Description
WizardPageSelectEventArgs e

EventArgs that contains the event data.

OnEndInit()

Declaration
protected virtual void OnEndInit()

OnNext(EventArgs)

Called when Next event is fired

Declaration
protected void OnNext(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs that contains the event data.

PageSettingsChanged()

Declaration
protected virtual void PageSettingsChanged()

PageSettingsChanged(Object, EventArgs)

Declaration
protected void PageSettingsChanged(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e

PreviousPage()

Selects the previous page.

Declaration
public void PreviousPage()

RefreshAppearance()

Declaration
protected virtual void RefreshAppearance()

remove_AfterPageSelect(Wizard.WizardPageSelectEventHandler)

Declaration
public void remove_AfterPageSelect(Wizard.WizardPageSelectEventHandler value)
Parameters
Type Name Description
Wizard.WizardPageSelectEventHandler value

remove_BeforePageSelect(Wizard.WizardPageSelectEventHandler)

Declaration
public void remove_BeforePageSelect(Wizard.WizardPageSelectEventHandler value)
Parameters
Type Name Description
Wizard.WizardPageSelectEventHandler value

RemovePage()

Removes the selectedPage.

Declaration
public void RemovePage()

RemovePage(WizardPage)

Removes the specified page.

Declaration
public void RemovePage(WizardPage page)
Parameters
Type Name Description
WizardPage page

The WizardPage to remove.

SetPageContainer(WizardContainer)

Sets the container for the pages.

Declaration
public virtual void SetPageContainer(WizardContainer container)
Parameters
Type Name Description
WizardContainer container

Wizard Container

Events

AfterPageSelect

This event gets fired when selected page get changed

Declaration
public event Wizard.WizardPageSelectEventHandler AfterPageSelect
Event Type
Type
Wizard.WizardPageSelectEventHandler

Back

This event is fired when the Back button is pressed or the PreviousPage method of the Wizard is called

Declaration
public event EventHandler Back
Event Type
Type
System.EventHandler

BeforePageSelect

This event gets fired when selected page is about to change

Declaration
public event Wizard.WizardPageSelectEventHandler BeforePageSelect
Event Type
Type
Wizard.WizardPageSelectEventHandler

Next

This event is fired when the Next button is pressed or the NextPage method of the Wizard is called.

Declaration
public event EventHandler Next
Event Type
Type
System.EventHandler

Implements

System.ComponentModel.ISupportInitialize