Class RadWizard

Represents a wizard control that helps you break a complex process into separate steps, providing navigation buttons and page management capabilities.

Inheritance
System.Object
RadControl
RadWizard
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadWizard : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadWizard()

Initializes a new instance of the RadWizard class.

Declaration
public RadWizard()

Properties

AutoSize

This property is not relevant for this control.

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

BackButton

Gets the command area's back button element.

Declaration
public RadButtonElement BackButton { get; }
Property Value
RadButtonElement

BackColor

This property is not relevant for this control.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

CancelButton

Gets the command area's cancel button element.

Declaration
public RadButtonElement CancelButton { get; }
Property Value
RadButtonElement

CommandArea

Gets the command area element that contains the navigation buttons.

Declaration
public WizardCommandArea CommandArea { get; }
Property Value
WizardCommandArea

CommandAreaHeight

Gets or sets the height of the command area. A negative value makes the command area autosize.

Declaration
public float CommandAreaHeight { get; set; }
Property Value
System.Single

CompletionImage

Gets or sets the image displayed on completion pages.

Declaration
public Image CompletionImage { get; set; }
Property Value
System.Drawing.Image

CompletionImageBackgroundShape

Gets or sets the background image shape for completion pages.

Declaration
public RadImageShape CompletionImageBackgroundShape { get; set; }
Property Value
RadImageShape

CompletionImageElement

Gets the element containing the image displayed on completion pages.

Declaration
public LightVisualElement CompletionImageElement { get; }
Property Value
LightVisualElement

CompletionImageLayout

Gets or sets the layout of the completion page image.

Declaration
public ImageLayout CompletionImageLayout { get; set; }
Property Value
System.Windows.Forms.ImageLayout

CompletionPage

Gets or sets the completion page of the wizard, which is typically displayed last in the wizard sequence.

Declaration
public WizardCompletionPage CompletionPage { get; set; }
Property Value
WizardCompletionPage

DefaultSize

Gets the default size for this control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

EnableAeroStyle

Gets or sets a value indicating whether the Aero style should be applied when the control is in Wizard Aero mode.

Declaration
public bool EnableAeroStyle { get; set; }
Property Value
System.Boolean

FinishButton

Gets the command area's finish button element.

Declaration
public RadButtonElement FinishButton { get; }
Property Value
RadButtonElement

ForeColor

This property is not relevant for this control.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

HelpButton

Gets the command area's help button element.

Declaration
public LightVisualElement HelpButton { get; }
Property Value
LightVisualElement

HideCompletionImage

Gets or sets a value indicating whether the image on completion pages should be hidden.

Declaration
public bool HideCompletionImage { get; set; }
Property Value
System.Boolean

HideWelcomeImage

Gets or sets a value indicating whether the image on welcome pages should be hidden.

Declaration
public bool HideWelcomeImage { get; set; }
Property Value
System.Boolean

Mode

Gets or sets the mode of the wizard control, determining its visual appearance and behavior.

Declaration
public WizardMode Mode { get; set; }
Property Value
WizardMode

NextButton

Gets the command area's next button element.

Declaration
public RadButtonElement NextButton { get; }
Property Value
RadButtonElement

PageHeaderElement

Gets the page header element that displays the title and description of the current page.

Declaration
public WizardPageHeaderElement PageHeaderElement { get; }
Property Value
WizardPageHeaderElement

PageHeaderHeight

Gets or sets the height of the page header. A negative value makes the page header autosize.

Declaration
public float PageHeaderHeight { get; set; }
Property Value
System.Single

PageHeaderIcon

Gets or sets the icon displayed in the page header.

Declaration
public Image PageHeaderIcon { get; set; }
Property Value
System.Drawing.Image

PageHeaderIconAlignment

Gets or sets the alignment of the page header's icon.

Declaration
public ContentAlignment PageHeaderIconAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

PageHeaderTextVisibility

Gets or sets the visibility of the page header's text element.

Declaration
public ElementVisibility PageHeaderTextVisibility { get; set; }
Property Value
ElementVisibility

Pages

Gets the collection of wizard pages contained in this RadWizard.

Declaration
public WizardPageCollection Pages { get; }
Property Value
WizardPageCollection

PageTitleTextVisibility

Gets or sets the visibility of the page header's title element.

Declaration
public ElementVisibility PageTitleTextVisibility { get; set; }
Property Value
ElementVisibility

SelectedPage

Gets or sets the currently selected wizard page.

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

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

WelcomeImage

Gets or sets the image displayed on welcome pages.

Declaration
public Image WelcomeImage { get; set; }
Property Value
System.Drawing.Image

WelcomeImageBackgroundShape

Gets or sets the background image shape for welcome pages.

Declaration
public RadImageShape WelcomeImageBackgroundShape { get; set; }
Property Value
RadImageShape

WelcomeImageElement

Gets the element containing the image displayed on welcome pages.

Declaration
public LightVisualElement WelcomeImageElement { get; }
Property Value
LightVisualElement

WelcomeImageLayout

Gets or sets the layout of the welcome page image.

Declaration
public ImageLayout WelcomeImageLayout { get; set; }
Property Value
System.Windows.Forms.ImageLayout

WelcomePage

Gets or sets the welcome page of the wizard, which is typically displayed first in the wizard sequence.

Declaration
public WizardWelcomePage WelcomePage { get; set; }
Property Value
WizardWelcomePage

WizardElement

Gets the RadWizardElement which encapsulates the UI representation and functionality of the control.

Declaration
public RadWizardElement WizardElement { get; }
Property Value
RadWizardElement

Methods

CreateAccessibilityInstance()

Creates an accessibility object for this control.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

A new RadWizardAccessibleObject if accessibility is enabled; otherwise, the base accessibility object.

CreateChildItems(RadElement)

Creates the child items of the wizard control, including the main wizard element.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element to which the child items will be added.
Overrides

Dispose(Boolean)

Releases the unmanaged resources used by the RadWizard and optionally releases the managed resources.

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

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

GiveFocusToNavigationButtonsLeft()

Determines whether the focus should go to the navigation buttons when the user presses the Left arrow key.

Declaration
protected virtual bool GiveFocusToNavigationButtonsLeft()
Returns
System.Boolean

true if the focus should go to the navigation buttons; otherwise, false.

GiveFocusToNavigationButtonsRight()

Determines whether the focus should go to the navigation buttons when the user presses the Right arrow key.

Declaration
protected virtual bool GiveFocusToNavigationButtonsRight()
Returns
System.Boolean

true if the focus should go to the navigation buttons; otherwise, false.

GiveFocusToNavigationButtonsShiftTab()

Determines whether the focus should go to the navigation buttons when the user presses Shift and Tab.

Declaration
protected virtual bool GiveFocusToNavigationButtonsShiftTab()
Returns
System.Boolean

true if the focus should go to the navigation buttons; otherwise, false.

GiveFocusToNavigationButtonsTab()

Determines whether the focus should go to the navigation buttons when the user presses Tab.

Declaration
protected virtual bool GiveFocusToNavigationButtonsTab()
Returns
System.Boolean

true if the focus should go to the navigation buttons; otherwise, false.

OnCancel(EventArgs)

Raises the Cancel event.

Declaration
protected virtual void OnCancel(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnFinish(EventArgs)

Raises the Finish event.

Declaration
protected virtual void OnFinish(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnHelp(EventArgs)

Raises the Help event.

Declaration
protected virtual void OnHelp(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnLostFocus(EventArgs)

Raises the System.Windows.Forms.Control.LostFocus event.

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnModeChanged(ModeChangedEventArgs)

Raises the ModeChanged event.

Declaration
protected virtual void OnModeChanged(ModeChangedEventArgs e)
Parameters
ModeChangedEventArgs e

A ModeChangedEventArgs that contains the event data.

OnModeChanging(ModeChangingEventArgs)

Raises the ModeChanging event.

Declaration
protected virtual void OnModeChanging(ModeChangingEventArgs e)
Parameters
ModeChangingEventArgs e

A ModeChangingEventArgs that contains the event data.

OnNext(WizardCancelEventArgs)

Raises the Next event.

Declaration
protected virtual void OnNext(WizardCancelEventArgs e)
Parameters
WizardCancelEventArgs e

A WizardCancelEventArgs that contains the event data.

OnPrevious(WizardCancelEventArgs)

Raises the Previous event.

Declaration
protected virtual void OnPrevious(WizardCancelEventArgs e)
Parameters
WizardCancelEventArgs e

A WizardCancelEventArgs that contains the event data.

OnSelectedPageChanged(Object, SelectedPageChangedEventArgs)

Raises the SelectedPageChanged event.

Declaration
protected virtual void OnSelectedPageChanged(object sender, SelectedPageChangedEventArgs e)
Parameters
System.Object sender

The source of the event.
SelectedPageChangedEventArgs e

A SelectedPageChangedEventArgs that contains the event data.

OnSelectedPageChanging(Object, SelectedPageChangingEventArgs)

Raises the SelectedPageChanging event.

Declaration
protected virtual void OnSelectedPageChanging(object sender, SelectedPageChangingEventArgs e)
Parameters
System.Object sender

The source of the event.
SelectedPageChangingEventArgs e

A SelectedPageChangingEventArgs that contains the event data.

ProcessDialogKey(Keys)

Processes a dialog key, handling navigation between wizard pages and buttons.

Declaration
protected override bool ProcessDialogKey(Keys keyData)
Parameters
System.Windows.Forms.Keys keyData

One of the System.Windows.Forms.Keys values that represents the key to process.
Returns
System.Boolean

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

ScaleControl(SizeF, BoundsSpecified)

Scales the control and its child controls by the specified factor.

Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
System.Drawing.SizeF factor

The factor by which the height and width of the control and its child controls is to be scaled.
System.Windows.Forms.BoundsSpecified specified

A System.Windows.Forms.BoundsSpecified value that specifies the bounds of the control to use when defining its size and position.
Overrides

SelectFirstWizardControl()

Selects the first wizard control in the tab order.

Declaration
protected virtual void SelectFirstWizardControl()

SelectLastWizardControl()

Selects the last wizard control in the tab order.

Declaration
protected virtual bool SelectLastWizardControl()
Returns
System.Boolean

true if a control was selected; otherwise, false.

SelectNextPage()

Navigates to the next wizard page in the sequence.

Declaration
public void SelectNextPage()

SelectPreviousPage()

Navigates to the previous wizard page in the sequence.

Declaration
public void SelectPreviousPage()

UnWireEvents()

Removes the event handlers for the wizard element and its child components.

Declaration
protected virtual void UnWireEvents()

WireEvents()

Wires up the event handlers for the wizard element and its child components.

Declaration
protected virtual void WireEvents()

Events

Cancel

Occurs when the Cancel command button is clicked.

Declaration
public event EventHandler Cancel
Event Type
System.EventHandler

Finish

Occurs when the Finish command button is clicked.

Declaration
public event EventHandler Finish
Event Type
System.EventHandler

Help

Occurs when the Help command button is clicked.

Declaration
public event EventHandler Help
Event Type
System.EventHandler

ModeChanged

Occurs after the mode of the RadWizard is changed.

Declaration
public event ModeChangedEventHandler ModeChanged
Event Type
ModeChangedEventHandler

ModeChanging

Occurs before the mode of the RadWizard is changed.

Declaration
public event ModeChangingEventHandler ModeChanging
Event Type
ModeChangingEventHandler

Next

Occurs when the Next command button is clicked.

Declaration
public event WizardCancelEventHandler Next
Event Type
WizardCancelEventHandler

Previous

Occurs when the Previous command button is clicked.

Declaration
public event WizardCancelEventHandler Previous
Event Type
WizardCancelEventHandler

SelectedPageChanged

Occurs after the selected page of the RadWizard is changed.

Declaration
public event SelectedPageChangedEventHandler SelectedPageChanged
Event Type
SelectedPageChangedEventHandler

SelectedPageChanging

Occurs before the selected page of the RadWizard is changed.

Declaration
public event SelectedPageChangingEventHandler SelectedPageChanging
Event Type
SelectedPageChangingEventHandler

Extension Methods