Wizard Class

public class Wizard : UIContainerControl, IUIControl, IUIElement, ILogicalTreeNode, IDisposable, ICommandTarget, ISupportInitialize

public Wizard()

Remarks

The default constructor initializes all fields to their default values.

public Button BackButton { get; }

Property Value

Button:

The Button instance that is used for the Back button.

Remarks

Use this property to directly access the Button control, allowing for advanced customization.

public Color BackButtonBackColor { get; set; }

Property Value

Color:

The background color of the Back button.

public bool BackButtonCausesValidation { get; set; }

Property Value

Boolean:

true if validation is performed when the Back button is clicked; otherwise, false. The default value is false.

public bool BackButtonEnabled { get; set; }

Property Value

Boolean:

true if the button is enabled; otherwise, false.

public int BackButtonTabIndex { get; set; }

Property Value

Int32:

The tab order of the Back button within its container.

public bool BackButtonTabStop { get; set; }

Property Value

Boolean:

true if the button has a tab stop; otherwise, false.

public string BackButtonText { get; set; }

Property Value

String:

The text displayed on the button.

public int BackButtonWidth { get; set; }

Property Value

Int32:

The width of the button.

public FlatStyle ButtonFlatStyle { get; set; }

Property Value

FlatStyle:

A FlatStyle specifying the flat style appearance of the buttons in the wizard.

public int ButtonHeight { get; set; }

Property Value

Int32:

The height of the buttons.

public Button CancelButton { get; }

Property Value

Button:

The Button instance that is used for the Cancel button.

Remarks

Use this property to directly access the Button control, allowing for advanced customization.

public Color CancelButtonBackColor { get; set; }

Property Value

Color:

The background color of the Cancel button.

public bool CancelButtonCausesValidation { get; set; }

Property Value

Boolean:

true if validation is performed when the Cancel button is clicked; otherwise, false. The default value is false.

public DialogResult CancelButtonDialogResult { get; set; }

Property Value

DialogResult:

The DialogResult for the Cancel button. The default value is DialogResult.Cancel.

public bool CancelButtonEnabled { get; set; }

Property Value

Boolean:

true if the button is enabled; otherwise, false.

public int CancelButtonTabIndex { get; set; }

Property Value

Int32:

The tab order of the Cancel button within its container.

public bool CancelButtonTabStop { get; set; }

Property Value

Boolean:

true if the button has a tab stop; otherwise, false.

public string CancelButtonText { get; set; }

Property Value

String:

The text displayed on the button.

public int CancelButtonWidth { get; set; }

Property Value

Int32:

The width of the button.

public CommandLinkCollection CommandLinks { get; }

Property Value

CommandLinkCollection:

A CommandLinkCollection containing the command links associated with the object.

public Control.ControlCollection Controls { get; }

Property Value

Control.ControlCollection:

The ControlCollection that contains the child controls of the wizard.

protected override Size DefaultSize { get; }

Property Value

Size:

The default Size of the control.

public bool DisableButtonsDuringPageChange { get; set; }

Property Value

Boolean:

true if wizard buttons should be disabled during page changes; otherwise, false.

Remarks

When a page change occurs, if this property is set to true, all the buttons are disabled until the page change is complete. The mouse cursor is also set to a wait cursor during the page change.

public Rectangle ExteriorPageBounds { get; }

Property Value

Rectangle:

A Rectangle specifying the bounds of interior pages.

public Button FinishButton { get; }

Property Value

Button:

The Button instance that is used for the Finish button.

Remarks

Use this property to directly access the Button control, allowing for advanced customization.

public Color FinishButtonBackColor { get; set; }

Property Value

Color:

The background color of the Finish button.

public bool FinishButtonCausesValidation { get; set; }

Property Value

Boolean:

true if validation is performed when the Finish button is clicked; otherwise, false. The default value is true.

public DialogResult FinishButtonDialogResult { get; set; }

Property Value

DialogResult:

The DialogResult for the Finish button. The default value is DialogResult.OK.

public bool FinishButtonDistinct { get; set; }

Property Value

Boolean:

true if the Finish button should always appear on its own; otherwise, false.

Remarks

This property should be set to true for wizards that have pages with the Next and Finish buttons enabled. Otherwise, the property should be set to false to adhere to the Wizard97 specification.

public bool FinishButtonEnabled { get; set; }

Property Value

Boolean:

true if the button is enabled; otherwise, false.

public int FinishButtonTabIndex { get; set; }

Property Value

Int32:

The tab order of the Finish button within its container.

public bool FinishButtonTabStop { get; set; }

Property Value

Boolean:

true if the button has a tab stop; otherwise, false.

public string FinishButtonText { get; set; }

Property Value

String:

The text displayed on the button.

public int FinishButtonWidth { get; set; }

Property Value

Int32:

The width of the button.

public override Font Font { get; set; }

Property Value

Font:

The Font to use for text in the control.

public WizardAcceptButtonDefault FormAcceptButton { get; set; }

Property Value

WizardAcceptButtonDefault:

A WizardAcceptButtonDefault specifying the accept button for the wizard.

public WizardCancelButtonDefault FormCancelButton { get; set; }

Property Value

WizardCancelButtonDefault:

A WizardCancelButtonDefault specifying the cancel button for the wizard.

public ICommandTarget ForwardCommandsTo { get; set; }

Property Value

ICommandTarget:

The ICommandTarget to forward commands to.

public Button HelpButton { get; }

Property Value

Button:

The Button instance that is used for the Help button.

Remarks

Use this property to directly access the Button control, allowing for advanced customization.

public bool HelpButtonAlignLeft { get; set; }

Property Value

Boolean:

true if the Help button is aligned to the left side of the wizard; otherwise, false.

public Color HelpButtonBackColor { get; set; }

Property Value

Color:

The background color of the Help button.

public bool HelpButtonCausesValidation { get; set; }

Property Value

Boolean:

true if validation is performed when the Help button is clicked; otherwise, false. The default value is false.

public bool HelpButtonEnabled { get; set; }

Property Value

Boolean:

true if the button is enabled; otherwise, false.

public int HelpButtonTabIndex { get; set; }

Property Value

Int32:

The tab order of the Help button within its container.

public bool HelpButtonTabStop { get; set; }

Property Value

Boolean:

true if the button has a tab stop; otherwise, false.

public string HelpButtonText { get; set; }

Property Value

String:

The text displayed on the button.

public int HelpButtonWidth { get; set; }

Property Value

Int32:

The width of the button.

public Rectangle InteriorPageBounds { get; }

Property Value

Rectangle:

A Rectangle specifying the bounds of interior pages.

public int InteriorPageGuideLineCount { get; set; }

Property Value

Int32:

The number of interior page guide lines to display in design-time mode.

Remarks

Set this property to 0 to display no guide lines.

public Button NextButton { get; }

Property Value

Button:

The Button instance that is used for the Next button.

Remarks

Use this property to directly access the Button control, allowing for advanced customization.

public Color NextButtonBackColor { get; set; }

Property Value

Color:

The background color of the Next button.

public bool NextButtonCausesValidation { get; set; }

Property Value

Boolean:

true if validation is performed when the Next button is clicked; otherwise, false. The default value is true.

public bool NextButtonEnabled { get; set; }

Property Value

Boolean:

true if the button is enabled; otherwise, false.

public int NextButtonTabIndex { get; set; }

Property Value

Int32:

The tab order of the Next button within its container.

public bool NextButtonTabStop { get; set; }

Property Value

Boolean:

true if the button has a tab stop; otherwise, false.

public string NextButtonText { get; set; }

Property Value

String:

The text displayed on the button.

public int NextButtonWidth { get; set; }

Property Value

Int32:

The width of the button.

public WizardPageCollection Pages { get; }

Property Value

WizardPageCollection:

A WizardPageCollection representing the pages in the Wizard.

Remarks

This property enables you to obtain a reference to the list of pages that are currently stored in the Wizard. With this reference, you can add pages, remove pages, and obtain a count of the pages in the collection. For more information on the tasks that can be performed with the Pages collection, see the WizardPageCollection class reference topics.

public WizardPageSequenceType PageSequenceType { get; set; }

Property Value

WizardPageSequenceType:

A WizardPageSequenceType specifying the type of page sequencing to perform.

public IWizardRenderer Renderer { get; set; }

Property Value

IWizardRenderer:

The IWizardRenderer used to render the control.

public int SelectedIndex { get; set; }

Property Value

Int32:

The index of the selected item. If there are no items in the control, this property returns -1.

Remarks

The index is zero-based.

public WizardPage SelectedPage { get; set; }

Property Value

WizardPage:

The WizardPage that is currently selected. null is returned if there is no page currently selected.

protected override bool UseExtendedDoubleBuffering { get; }

Property Value

Boolean:

true if extended double buffering should be used; otherwise, false.

protected override Size ArrangeOverride(Size finalSize)

Parameter	Type	Description
finalSize	Size	The final area within the parent that this element should use to arrange itself and its children.

Returns

Size:

The actual size used.

Remarks

Element authors should override this method, call Arrange on each visible child element and position each child element. It is required that a parent element calls Arrange on each child or they won't be rendered.

protected override IList CreateChildren()

Returns

IList:

The IList that should be assigned to the Children property.

Remarks

By default no child collection is created.

protected override Control.ControlCollection CreateControlsInstance()

Returns

Control.ControlCollection:

A new instance of a Control.ControlCollection assigned to the control.

protected override void Dispose(bool disposing)

Parameter	Type	Description
disposing	Boolean	Whether the object is being disposed.

public void EndInitialization()

protected override PointHitTestResult HitTest(PointHitTestParameters hitTestParams, Func<IUIElement, PointHitTestParameters, bool> filter)

Parameter	Type	Description
hitTestParams	PointHitTestParameters	A PointHitTestParameters containing hit test parameters.
filter	Func<IUIElement, PointHitTestParameters, Boolean>	Optionally defines a filter which must return true for an element to match the hit test.

Returns

PointHitTestResult:

A PointHitTestResult containing the hit test result.

protected override PointHitTestResult HitTestRecursive(PointHitTestParameters hitTestParams, Func<IUIElement, PointHitTestParameters, bool> filter)

Parameter	Type	Description
hitTestParams	PointHitTestParameters	A PointHitTestParameters containing hit test parameters.
filter	Func<IUIElement, PointHitTestParameters, Boolean>	Optionally defines a filter which must return true for an element to match the hit test.

Returns

PointHitTestResult:

A PointHitTestResult containing the hit test result.

protected virtual void OnBackButtonClick(WizardPageCancelEventArgs e)

Parameter	Type	Description
e	WizardPageCancelEventArgs	A WizardPageCancelEventArgs that contains the event data.

protected virtual void OnButtonMouseEnter(WizardButtonEventArgs e)

Parameter	Type	Description
e	WizardButtonEventArgs	A WizardButtonEventArgs that contains the event data.

protected virtual void OnButtonMouseLeave(WizardButtonEventArgs e)

Parameter	Type	Description
e	WizardButtonEventArgs	A WizardButtonEventArgs that contains the event data.

protected virtual void OnCancelButtonClick(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnFinishButtonClick(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnHelpButtonClick(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnLayoutButtons(WizardLayoutButtonsEventArgs e)

Parameter	Type	Description
e	WizardLayoutButtonsEventArgs	An EventArgs that contains the event data.

protected override void OnMouseDown(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs that contains the event data.

protected virtual void OnNextButtonClick(WizardPageCancelEventArgs e)

Parameter	Type	Description
e	WizardPageCancelEventArgs	A WizardPageCancelEventArgs that contains the event data.

protected override void OnParentChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnRender(PaintEventArgs e)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.

protected override void OnResize(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnSelectionChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnSelectionChanging(WizardPageCancelEventArgs e)

Parameter	Type	Description
e	WizardPageCancelEventArgs	A WizardPageCancelEventArgs that contains the event data.

public void PerformBackButtonClick()

public void PerformCancelButtonClick()

public void PerformFinishButtonClick()

public void PerformHelpButtonClick()

public void PerformNextButtonClick()

protected override bool ProcessDialogKey(Keys keyData)

Parameter	Type	Description
keyData	Keys	One of the Keys values that represents the key to process.

Returns

Boolean:

true if the key was processed by the control; otherwise, false.

protected override bool ProcessTabKey(bool forward)

Parameter	Type	Description
forward	Boolean	true to cycle forward through the controls in the ContainerControl; otherwise, false.

Returns

Boolean:

true if a control is selected; otherwise, false.

public virtual bool RaiseCommand(Command command)

Parameter	Type	Description
command	Command	The Command to raise.

Returns

Boolean:

true if the Command was handled; otherwise, false.

public void ResetBackButtonBackColor()

public void ResetCancelButtonBackColor()

public void ResetFinishButtonBackColor()

public void ResetHelpButtonBackColor()

public void ResetNextButtonBackColor()

public virtual void ResetRenderer()

public bool ShouldSerializeBackButtonBackColor()

Returns

Boolean:

true if the property value has changed from its default; otherwise, false.

public bool ShouldSerializeCancelButtonBackColor()

Returns

Boolean:

true if the property value has changed from its default; otherwise, false.

public bool ShouldSerializeFinishButtonBackColor()

Returns

Boolean:

true if the property value has changed from its default; otherwise, false.

public bool ShouldSerializeHelpButtonBackColor()

Returns

Boolean:

true if the property value has changed from its default; otherwise, false.

public bool ShouldSerializeNextButtonBackColor()

Returns

Boolean:

true if the property value has changed from its default; otherwise, false.

public bool ShouldSerializePages()

Returns

Boolean:

true if the pages collection should be serialized; otherwise false.

public virtual bool ShouldSerializeRenderer()

Returns

Boolean:

true if the property value has changed from its default; otherwise, false.

protected override void WndProc(ref Message m)

Parameter	Type	Description
m	Message	The Windows Message to process.

public event WizardPageCancelEventHandler BackButtonClick

Event Type

WizardPageCancelEventHandler

Remarks

By default, the Wizard will move to the previous WizardPage in the WizardPageCollection after this event fires. To cancel this behavior, set the Cancel property of the event argument to true. Then you can use the SelectedPage property to set the WizardPage that should be displayed.

If the selected page has an event handler for this event, this particular event will not be raised since it will be assumed that the associated page's event handler executed the appropriate code.

public event WizardButtonEventHandler ButtonMouseEnter

Event Type

WizardButtonEventHandler

public event WizardButtonEventHandler ButtonMouseLeave

Event Type

WizardButtonEventHandler

public event EventHandler CancelButtonClick

Event Type

EventHandler

Remarks

Handlers of this event generally abort any currently-executing processing tasks and close the Form containing the Wizard control.

If the selected page has an event handler for this event, this particular event will not be raised since it will be assumed that the associated page's event handler executed the appropriate code.

public event EventHandler FinishButtonClick

Event Type

EventHandler

Remarks

Handlers of this event generally finish processing any remaining wizard tasks.

If the selected page has an event handler for this event, this particular event will not be raised since it will be assumed that the associated page's event handler executed the appropriate code.

public event EventHandler HelpButtonClick

Event Type

EventHandler

Remarks

Handlers of this event generally display help for the currently displayed wizard step.

If the selected page has an event handler for this event, this particular event will not be raised since it will be assumed that the associated page's event handler executed the appropriate code.

public event WizardLayoutButtonsEventHandler LayoutButtons

Event Type

WizardLayoutButtonsEventHandler

public event WizardPageCancelEventHandler NextButtonClick

Event Type

WizardPageCancelEventHandler

Remarks

By default, the Wizard will move to the next WizardPage in the WizardPageCollection after this event fires. To cancel this behavior, set the Cancel property of the event argument to true. Then you can use the SelectedPage property to set the WizardPage that should be displayed.

If the selected page has an event handler for this event, this particular event will not be raised since it will be assumed that the associated page's event handler executed the appropriate code.

public event EventHandler SelectionChanged

Event Type

EventHandler

Remarks

Use this event to perform any processing that should occur after the selected page changes.

public event WizardPageCancelEventHandler SelectionChanging

Event Type

WizardPageCancelEventHandler

Remarks

Use this event to perform any processing that should occur before selected page changes. The Page property of the event arguments indicates the WizardPage about to be selected. The selection change may be cancelled by setting the Cancel property of the event arguments to true.