Class

RadWizard

Initializes a new instance of the RadWizard class.

Declaration

public RadWizard()

Gets the command area's back button element.

Declaration

[Browsable(false)]
public RadButtonElement BackButton { get; }

Property Value

Gets the command area's cancel button element.

Declaration

[Browsable(false)]
public RadButtonElement CancelButton { get; }

Property Value

Gets the command area element that contains the navigation buttons.

Declaration

[Browsable(false)]
public WizardCommandArea CommandArea { get; }

Property Value

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

Gets or sets the image displayed on completion pages.

Declaration

public Image CompletionImage { get; set; }

Property Value

Gets or sets the background image shape for completion pages.

Declaration

[Browsable(false)]
public RadImageShape CompletionImageBackgroundShape { get; set; }

Property Value

Gets the element containing the image displayed on completion pages.

Declaration

[Browsable(false)]
public LightVisualElement CompletionImageElement { get; }

Property Value

Gets or sets the layout of the completion page image.

Declaration

[Browsable(false)]
public ImageLayout CompletionImageLayout { get; set; }

Property Value

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

Gets the default size for this control.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

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

Gets the command area's finish button element.

Declaration

[Browsable(false)]
public RadButtonElement FinishButton { get; }

Property Value

Gets the command area's help button element.

Declaration

[Browsable(false)]
public LightVisualElement HelpButton { get; }

Property Value

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

Declaration

public bool HideCompletionImage { get; set; }

Property Value

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

Declaration

public bool HideWelcomeImage { get; set; }

Property Value

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

Declaration

[Browsable(true)]
public WizardMode Mode { get; set; }

Property Value

Gets the command area's next button element.

Declaration

[Browsable(false)]
public RadButtonElement NextButton { get; }

Property Value

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

Declaration

[Browsable(false)]
public WizardPageHeaderElement PageHeaderElement { get; }

Property Value

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

Gets or sets the icon displayed in the page header.

Declaration

public Image PageHeaderIcon { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public ContentAlignment PageHeaderIconAlignment { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public ElementVisibility PageHeaderTextVisibility { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public ElementVisibility PageTitleTextVisibility { get; set; }

Property Value

Gets the collection of wizard pages contained in this RadWizard.

Declaration

[Browsable(true)]
public WizardPageCollection Pages { get; }

Property Value

Gets or sets the currently selected wizard page.

Declaration

[Browsable(false)]
public WizardPage SelectedPage { get; set; }

Property Value

Gets or sets the image displayed on welcome pages.

Declaration

public Image WelcomeImage { get; set; }

Property Value

Gets or sets the background image shape for welcome pages.

Declaration

[Browsable(false)]
public RadImageShape WelcomeImageBackgroundShape { get; set; }

Property Value

Gets the element containing the image displayed on welcome pages.

Declaration

[Browsable(false)]
public LightVisualElement WelcomeImageElement { get; }

Property Value

Gets or sets the layout of the welcome page image.

Declaration

[Browsable(false)]
public ImageLayout WelcomeImageLayout { get; set; }

Property Value

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

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

Declaration

[Browsable(false)]
public RadWizardElement WizardElement { get; }

Property Value

Creates an accessibility object for this control.

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

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

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

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

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides RadControl.Dispose(bool)

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

Declaration

protected virtual bool GiveFocusToNavigationButtonsLeft()

Returns

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

Declaration

protected virtual bool GiveFocusToNavigationButtonsRight()

Returns

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

Declaration

protected virtual bool GiveFocusToNavigationButtonsShiftTab()

Returns

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

Declaration

protected virtual bool GiveFocusToNavigationButtonsTab()

Returns

Raises the Cancel event.

Declaration

protected virtual void OnCancel(EventArgs e)

Parameters

Raises the Finish event.

Declaration

protected virtual void OnFinish(EventArgs e)

Parameters

Raises the Help event.

Declaration

protected virtual void OnHelp(EventArgs e)

Parameters

Raises the LostFocus event.

Declaration

protected override void OnLostFocus(EventArgs e)

Parameters

Overrides RadControl.OnLostFocus(EventArgs)

Raises the ModeChanged event.

Declaration

protected virtual void OnModeChanged(ModeChangedEventArgs e)

Parameters

Raises the ModeChanging event.

Declaration

protected virtual void OnModeChanging(ModeChangingEventArgs e)

Parameters

Raises the Next event.

Declaration

protected virtual void OnNext(WizardCancelEventArgs e)

Parameters

Raises the Previous event.

Declaration

protected virtual void OnPrevious(WizardCancelEventArgs e)

Parameters

Raises the SelectedPageChanged event.

Declaration

protected virtual void OnSelectedPageChanged(object sender, SelectedPageChangedEventArgs e)

Parameters

Raises the SelectedPageChanging event.

Declaration

protected virtual void OnSelectedPageChanging(object sender, SelectedPageChangingEventArgs e)

Parameters

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

Declaration

protected override bool ProcessDialogKey(Keys keyData)

Parameters

Returns

Overrides Control.ProcessDialogKey(Keys)

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

Declaration

protected override void ScaleControl(SizeF factor, BoundsSpecified specified)

Parameters

Overrides RadControl.ScaleControl(SizeF, BoundsSpecified)

Selects the first wizard control in the tab order.

Declaration

protected virtual void SelectFirstWizardControl()

Selects the last wizard control in the tab order.

Declaration

protected virtual bool SelectLastWizardControl()

Returns

Navigates to the next wizard page in the sequence.

Declaration

public void SelectNextPage()

Navigates to the previous wizard page in the sequence.

Declaration

public void SelectPreviousPage()

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

Declaration

protected virtual void UnWireEvents()

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

Declaration

protected virtual void WireEvents()

Occurs when the Cancel command button is clicked.

Declaration

public event EventHandler Cancel

Event Value

Occurs when the Finish command button is clicked.

Declaration

public event EventHandler Finish

Event Value

Occurs when the Help command button is clicked.

Declaration

public event EventHandler Help

Event Value

Occurs after the mode of the RadWizard is changed.

Declaration

public event ModeChangedEventHandler ModeChanged

Event Value

Occurs before the mode of the RadWizard is changed.

Declaration

public event ModeChangingEventHandler ModeChanging

Event Value

Occurs when the Next command button is clicked.

Declaration

public event WizardCancelEventHandler Next

Event Value

Occurs when the Previous command button is clicked.

Declaration

public event WizardCancelEventHandler Previous

Event Value

Occurs after the selected page of the RadWizard is changed.

Declaration

public event SelectedPageChangedEventHandler SelectedPageChanged

Event Value

Occurs before the selected page of the RadWizard is changed.

Declaration

public event SelectedPageChangingEventHandler SelectedPageChanging

Event Value