RadWizard
Represents a wizard control that helps you break a complex process into separate steps, providing navigation buttons and page management capabilities.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadWizard : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadWizard...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadWizard class.
public RadWizard()Properties
Gets the command area's back button element.
[Browsable(false)]
public RadButtonElement BackButton { get; }Gets the command area's cancel button element.
[Browsable(false)]
public RadButtonElement CancelButton { get; }Gets the command area element that contains the navigation buttons.
[Browsable(false)]
public WizardCommandArea CommandArea { get; }Gets or sets the height of the command area. A negative value makes the command area autosize.
public float CommandAreaHeight { get; set; }Gets or sets the image displayed on completion pages.
public Image CompletionImage { get; set; }Gets or sets the background image shape for completion pages.
[Browsable(false)]
public RadImageShape CompletionImageBackgroundShape { get; set; }Gets the element containing the image displayed on completion pages.
[Browsable(false)]
public LightVisualElement CompletionImageElement { get; }Gets or sets the layout of the completion page image.
[Browsable(false)]
public ImageLayout CompletionImageLayout { get; set; }Gets or sets the completion page of the wizard, which is typically displayed last in the wizard sequence.
public WizardCompletionPage CompletionPage { get; set; }Gets the default size for this control.
protected override Size DefaultSize { get; }Overrides:
Gets or sets a value indicating whether the Aero style should be applied when the control is in Wizard Aero mode.
public bool EnableAeroStyle { get; set; }Gets the command area's finish button element.
[Browsable(false)]
public RadButtonElement FinishButton { get; }Gets the command area's help button element.
[Browsable(false)]
public LightVisualElement HelpButton { get; }Gets or sets a value indicating whether the image on completion pages should be hidden.
public bool HideCompletionImage { get; set; }Gets or sets a value indicating whether the image on welcome pages should be hidden.
public bool HideWelcomeImage { get; set; }Gets or sets the mode of the wizard control, determining its visual appearance and behavior.
[Browsable(true)]
public WizardMode Mode { get; set; }Gets the command area's next button element.
[Browsable(false)]
public RadButtonElement NextButton { get; }Gets the page header element that displays the title and description of the current page.
[Browsable(false)]
public WizardPageHeaderElement PageHeaderElement { get; }Gets or sets the height of the page header. A negative value makes the page header autosize.
public float PageHeaderHeight { get; set; }Gets or sets the icon displayed in the page header.
public Image PageHeaderIcon { get; set; }Gets or sets the alignment of the page header's icon.
[Browsable(false)]
public ContentAlignment PageHeaderIconAlignment { get; set; }Gets or sets the visibility of the page header's text element.
[Browsable(false)]
public ElementVisibility PageHeaderTextVisibility { get; set; }Gets the collection of wizard pages contained in this RadWizard.
[Browsable(true)]
public WizardPageCollection Pages { get; }Gets or sets the visibility of the page header's title element.
[Browsable(false)]
public ElementVisibility PageTitleTextVisibility { get; set; }Gets or sets the currently selected wizard page.
[Browsable(false)]
public WizardPage SelectedPage { get; set; }Gets or sets the image displayed on welcome pages.
public Image WelcomeImage { get; set; }Gets or sets the background image shape for welcome pages.
[Browsable(false)]
public RadImageShape WelcomeImageBackgroundShape { get; set; }Gets the element containing the image displayed on welcome pages.
[Browsable(false)]
public LightVisualElement WelcomeImageElement { get; }Gets or sets the layout of the welcome page image.
[Browsable(false)]
public ImageLayout WelcomeImageLayout { get; set; }Gets or sets the welcome page of the wizard, which is typically displayed first in the wizard sequence.
public WizardWelcomePage WelcomePage { get; set; }Gets the RadWizardElement which encapsulates the UI representation and functionality of the control.
[Browsable(false)]
public RadWizardElement WizardElement { get; }Methods
Creates an accessibility object for this control.
protected override AccessibleObject CreateAccessibilityInstance()A new RadWizardAccessibleObject if accessibility is enabled; otherwise, the base accessibility object.
Overrides:
Creates the child items of the wizard control, including the main wizard element.
protected override void CreateChildItems(RadElement parent)The parent element to which the child items will be added.
Overrides:
Determines whether the focus should go to the navigation buttons when the user presses the Left arrow key.
protected virtual bool GiveFocusToNavigationButtonsLeft()true if the focus should go to the navigation buttons; otherwise, false.
Determines whether the focus should go to the navigation buttons when the user presses the Right arrow key.
protected virtual bool GiveFocusToNavigationButtonsRight()true if the focus should go to the navigation buttons; otherwise, false.
Determines whether the focus should go to the navigation buttons when the user presses Shift and Tab.
protected virtual bool GiveFocusToNavigationButtonsShiftTab()true if the focus should go to the navigation buttons; otherwise, false.
Determines whether the focus should go to the navigation buttons when the user presses Tab.
protected virtual bool GiveFocusToNavigationButtonsTab()true if the focus should go to the navigation buttons; otherwise, false.
Raises the ModeChanged event.
protected virtual void OnModeChanged(ModeChangedEventArgs e)A ModeChangedEventArgs that contains the event data.
Raises the ModeChanging event.
protected virtual void OnModeChanging(ModeChangingEventArgs e)A ModeChangingEventArgs that contains the event data.
Raises the Next event.
protected virtual void OnNext(WizardCancelEventArgs e)A WizardCancelEventArgs that contains the event data.
Raises the Previous event.
protected virtual void OnPrevious(WizardCancelEventArgs e)A WizardCancelEventArgs that contains the event data.
Raises the SelectedPageChanged event.
protected virtual void OnSelectedPageChanged(object sender, SelectedPageChangedEventArgs e)The source of the event.
eSelectedPageChangedEventArgsA SelectedPageChangedEventArgs that contains the event data.
Raises the SelectedPageChanging event.
protected virtual void OnSelectedPageChanging(object sender, SelectedPageChangingEventArgs e)The source of the event.
eSelectedPageChangingEventArgsA SelectedPageChangingEventArgs that contains the event data.
Processes a dialog key, handling navigation between wizard pages and buttons.
Scales the control and its child controls by the specified factor.
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)The factor by which the height and width of the control and its child controls is to be scaled.
specifiedBoundsSpecifiedA BoundsSpecified value that specifies the bounds of the control to use when defining its size and position.
Overrides:
Selects the first wizard control in the tab order.
protected virtual void SelectFirstWizardControl()Selects the last wizard control in the tab order.
protected virtual bool SelectLastWizardControl()true if a control was selected; otherwise, false.
Navigates to the next wizard page in the sequence.
public void SelectNextPage()Navigates to the previous wizard page in the sequence.
public void SelectPreviousPage()Removes the event handlers for the wizard element and its child components.
protected virtual void UnWireEvents()Wires up the event handlers for the wizard element and its child components.
protected virtual void WireEvents()Events
Occurs when the Cancel command button is clicked.
public event EventHandler CancelOccurs when the Finish command button is clicked.
public event EventHandler FinishOccurs when the Help command button is clicked.
public event EventHandler HelpOccurs after the mode of the RadWizard is changed.
public event ModeChangedEventHandler ModeChangedOccurs before the mode of the RadWizard is changed.
public event ModeChangingEventHandler ModeChangingOccurs when the Next command button is clicked.
public event WizardCancelEventHandler NextOccurs when the Previous command button is clicked.
public event WizardCancelEventHandler PreviousOccurs after the selected page of the RadWizard is changed.
public event SelectedPageChangedEventHandler SelectedPageChangedOccurs before the selected page of the RadWizard is changed.
public event SelectedPageChangingEventHandler SelectedPageChanging