Class RadWizard

RadWizard is a control which helps you to break a complex process into separate steps.

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()

Creates a RadWizard instance.

Declaration
public RadWizard()

Properties

AutoSize

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

Overrides

BackButton

Gets the command area's back button.

Declaration
public RadButtonElement BackButton { get; }
Property Value
RadButtonElement

BackColor

RadWizard consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

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

Overrides

CancelButton

Gets the command area's cancel button.

Declaration
public RadButtonElement CancelButton { get; }
Property Value
RadButtonElement

CommandArea

Gets the command area element.

Declaration
public WizardCommandArea CommandArea { get; }
Property Value
WizardCommandArea

CommandAreaHeight

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

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

CompletionImage

Gets or sets the image of the completion pages.

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

CompletionImageBackgroundShape

Gets or sets the background image shape of the completion pages.

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

CompletionImageElement

Gets the element containing the image of the completion pages.

Declaration
public LightVisualElement CompletionImageElement { get; }
Property Value
LightVisualElement

CompletionImageLayout

Gets or sets the layout of the completion pages image.

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

CompletionPage

Gets or sets the completion page.

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

DefaultSize

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

EnableAeroStyle

Gets or sets a value indication wether the Aero style should apply 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.

Declaration
public RadButtonElement FinishButton { get; }
Property Value
RadButtonElement

ForeColor

RadWizard consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

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

Overrides

HelpButton

Gets the command area's help button.

Declaration
public LightVisualElement HelpButton { get; }
Property Value
LightVisualElement

HideCompletionImage

Gets or sets a value indicating whether the image of the completion pages should be visible.

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

HideWelcomeImage

Gets or sets a value indicating whether the image of the welcome pages should be visible.

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

Mode

Gets or sets the mode of the control.

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

NextButton

Gets the command area's next button.

Declaration
public RadButtonElement NextButton { get; }
Property Value
RadButtonElement

PageHeaderElement

Gets the page header element.

Declaration
public WizardPageHeaderElement PageHeaderElement { get; }
Property Value
WizardPageHeaderElement

PageHeaderHeight

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

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

PageHeaderIcon

Gets or sets the icon of 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 header element.

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

Pages

Gets the pages collection.

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 selected 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 of the welcome pages.

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

WelcomeImageBackgroundShape

Gets or sets the background image shape of the welcome pages.

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

WelcomeImageElement

Gets the element containing the image of the welcome pages.

Declaration
public LightVisualElement WelcomeImageElement { get; }
Property Value
LightVisualElement

WelcomeImageLayout

Gets or sets the layout of the welcome pages image.

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

WelcomePage

Gets or sets the welcome page.

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()

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

CreateChildItems(RadElement)

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

Overrides

Dispose(Boolean)

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

Overrides

GiveFocusToNavigationButtonsLeft()

Returns true if the focus should go the navigation buttons when the user presses Left arrow

Declaration
protected virtual bool GiveFocusToNavigationButtonsLeft()
Returns
System.Boolean

GiveFocusToNavigationButtonsRight()

Returns true if the focus should go the navigation buttons when the user presses Right arrow

Declaration
protected virtual bool GiveFocusToNavigationButtonsRight()
Returns
System.Boolean

GiveFocusToNavigationButtonsShiftTab()

Returns true if the focus should go the navigation buttons when the user presses Shift and Tab

Declaration
protected virtual bool GiveFocusToNavigationButtonsShiftTab()
Returns
System.Boolean

GiveFocusToNavigationButtonsTab()

Returns true if the focus should go the navigation buttons when the user presses Tab

Declaration
protected virtual bool GiveFocusToNavigationButtonsTab()
Returns
System.Boolean

OnCancel(EventArgs)

Raises the Cancel event.

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

An instance of System.EventArgs.

OnFinish(EventArgs)

Raises the Finish event.

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

An instance of System.EventArgs.

OnHelp(EventArgs)

Raises the Help event.

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

An instance of System.EventArgs.

OnLostFocus(EventArgs)

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

Overrides

OnModeChanged(ModeChangedEventArgs)

Raises the ModeChanged event.

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

An instance of ModeChangedEventArgs containing event data.

OnModeChanging(ModeChangingEventArgs)

Raises the ModeChanging event.

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

An instance of ModeChangingEventArgs containing event data.

OnNext(WizardCancelEventArgs)

Raises the Next event.

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

An instance of WizardCancelEventArgs containing event data.

OnPrevious(WizardCancelEventArgs)

Raises the Previous event.

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

An instance of WizardCancelEventArgs containing event data.

OnSelectedPageChanged(Object, SelectedPageChangedEventArgs)

Raises the SelectedPageChanged event.

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

The owner.
SelectedPageChangedEventArgs e

An instance of SelectedPageChangedEventArgs containing event data.

OnSelectedPageChanging(Object, SelectedPageChangingEventArgs)

Raises the SelectedPageChanging event.

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

The owner.
SelectedPageChangingEventArgs e

An instance of SelectedPageChangingEventArgs containing event data.

ProcessDialogKey(Keys)

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

Returns
System.Boolean

ScaleControl(SizeF, BoundsSpecified)

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

System.Windows.Forms.BoundsSpecified specified

Overrides

SelectFirstWizardControl()

Declaration
protected virtual void SelectFirstWizardControl()

SelectLastWizardControl()

Declaration
protected virtual bool SelectLastWizardControl()
Returns
System.Boolean

SelectNextPage()

Selects next wizard page.

Declaration
public void SelectNextPage()

SelectPreviousPage()

Selects previous wizard page.

Declaration
public void SelectPreviousPage()

UnWireEvents()

Declaration
protected virtual void UnWireEvents()

WireEvents()

Declaration
protected virtual void WireEvents()

Events

Cancel

Fires when the cancel command button is clicked.

Declaration
public event EventHandler Cancel
Event Type
System.EventHandler

Finish

Fires when the finish command button is clicked.

Declaration
public event EventHandler Finish
Event Type
System.EventHandler

Help

Fires when the help command button is clicked.

Declaration
public event EventHandler Help
Event Type
System.EventHandler

ModeChanged

Fires after the mode of RadWizard is changed.

Declaration
public event ModeChangedEventHandler ModeChanged
Event Type
ModeChangedEventHandler

ModeChanging

Fires before the mode of RadWizard is changed.

Declaration
public event ModeChangingEventHandler ModeChanging
Event Type
ModeChangingEventHandler

Next

Fires when the next command button is clicked.

Declaration
public event WizardCancelEventHandler Next
Event Type
WizardCancelEventHandler

Previous

Fires when the back command button is clicked.

Declaration
public event WizardCancelEventHandler Previous
Event Type
WizardCancelEventHandler

SelectedPageChanged

Fires after the selected page of RadWizard is changed.

Declaration
public event SelectedPageChangedEventHandler SelectedPageChanged
Event Type
SelectedPageChangedEventHandler

SelectedPageChanging

Fires before the selected page of RadWizard is changed.

Declaration
public event SelectedPageChangingEventHandler SelectedPageChanging
Event Type
SelectedPageChangingEventHandler

Extension Methods