RadWizard
The RadWizard class provides a user interface control designed to guide users through a structured sequence of steps in a wizard-like fashion. It allows complex processes to be broken down into manageable sections or pages, facilitating smooth navigation and interaction. The class maintains a collection of wizard pages, supports commands for navigating between them, and enables event handling to respond to user actions such as moving to the next or previous page, finishing the wizard, cancelling, or invoking help. This control is beneficial for applications that require users to complete processes that involve multiple steps, ensuring clear guidance and feedback throughout the experience.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.Navigation.dll
Syntax:
[TelerikToolboxCategory("Navigation")]
public class RadWizard : Control
Inheritance: objectRadWizard
Constructors
Initializes a new instance of the RadWizard class.
public RadWizard()
Fields
CanCancelProperty
DependencyProperty
CanCancelPropertyKey
DependencyPropertyKey
Identifies the CanCancel dependency property.
public static readonly DependencyPropertyKey CanCancelPropertyKey
CanFinishProperty
DependencyProperty
CanFinishPropertyKey
DependencyPropertyKey
Identifies the CanFinish dependency property.
public static readonly DependencyPropertyKey CanFinishPropertyKey
CanHelpProperty
DependencyProperty
CanHelpPropertyKey
DependencyPropertyKey
Identifies the CanHelp dependency property.
public static readonly DependencyPropertyKey CanHelpPropertyKey
CanMoveCurrentToNextProperty
DependencyProperty
Identifies the CanMoveCurrentToNext dependency property.
public static readonly DependencyProperty CanMoveCurrentToNextProperty
The identifier for the CanMoveCurrentToNext dependency property.
CanMoveCurrentToNextPropertyKey
DependencyPropertyKey
Identifies the CanMoveCurrentToNext dependency property.
public static readonly DependencyPropertyKey CanMoveCurrentToNextPropertyKey
CanMoveCurrentToPreviousProperty
DependencyProperty
Identifies the CanMoveCurrentToPrevious dependency property.
public static readonly DependencyProperty CanMoveCurrentToPreviousProperty
The identifier for the CanMoveCurrentToPrevious dependency property.
CanMoveCurrentToPreviousPropertyKey
DependencyPropertyKey
Identifies the CanMoveCurrentToPrevious dependency property.
public static readonly DependencyPropertyKey CanMoveCurrentToPreviousPropertyKey
CommandProviderProperty
DependencyProperty
Represents the CommandProvider DependencyProperty.
public static readonly DependencyProperty CommandProviderProperty
DirectionProperty
DependencyProperty
Identifies the Direction DependencyProperty.
public static readonly DependencyProperty DirectionProperty
IsContentPreservedProperty
DependencyProperty
Represents the IsContentPreserved DependencyProperty.
public static readonly DependencyProperty IsContentPreservedProperty
SelectedPageIndexProperty
DependencyProperty
Represents the SelectedPageIndex DependencyProperty.
public static readonly DependencyProperty SelectedPageIndexProperty
SelectedPageProperty
DependencyProperty
Represents the SelectedPage DependencyProperty.
public static readonly DependencyProperty SelectedPageProperty
Properties
Gets a value that indicates whether the user can cancel the operation.
public bool CanCancel { get; }
true if the user can cancel the operation; otherwise, false.
Gets a value that indicates whether the user can finish the operation.
public bool CanFinish { get; }
true if the user can finish the operation; otherwise, false.
Gets a value that indicates whether the user can receive help.
public bool CanHelp { get; }
Gets a value that indicates whether the user can move the current page to the next position.
public bool CanMoveCurrentToNext { get; }
true if the user can move the current page to the next position; otherwise, false.
Gets a value that indicates whether the user can move the current page to the previous position.
public bool CanMoveCurrentToPrevious { get; }
true if the user can move the current page to the previous position; otherwise, false.
Exposes a WizardCommandProvider.
public WizardCommandProvider CommandProvider { get; set; }
Gets or sets a value indicating whether the state of the content of WizardPage will be preserved when selection is changed.
public bool IsContentPreserved { get; set; }
Gets or sets the SelectedPage.
public WizardPage SelectedPage { get; set; }
Gets or sets the SelectedPageIndex.
public int SelectedPageIndex { get; set; }
Returns a collection of wizard's pages.
public WizardPageCollection WizardPages { get; }
Methods
When overridden in a derived class, is invoked whenever application code or internal processes call .
public override void OnApplyTemplate()
Raises the Cancel event.
protected virtual void OnCancel(NavigationButtonsEventArgs e)
Raises the Completed event.
protected virtual void OnCompleted(WizardCompletedEventArgs e)
Raises the Completing event.
protected virtual void OnCompleting(WizardCompletingEventArgs e)
OnCreateAutomationPeer()
AutomationPeer
Returns an automation peer for this RadWizard.
protected override AutomationPeer OnCreateAutomationPeer()
AutomationPeer
Raises the Finish event.
protected virtual void OnFinish(NavigationButtonsEventArgs e)
Raises the Help event.
protected virtual void OnHelp(NavigationButtonsEventArgs e)
Raises the event. This method is invoked whenever is set to true internally.
protected override void OnInitialized(EventArgs e)
The RoutedEventArgs that contains the event data.
Called when the root MouseLeftButtonDown event is fired.
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Raises the Next event.
protected virtual void OnNext(NavigationButtonsEventArgs args)
Raises the PageLoaded event.
Raises the Previous event.
protected virtual void OnPrevious(NavigationButtonsEventArgs args)
Raises the SelectionChanged event.
protected virtual void OnSelectionChanged(SelectedPageChangedEventArgs e)
Raises the SelectionChanging event.
protected virtual void OnSelectionChanging(SelectedPageChangingEventArgs e)
Resets the theme.
public void ResetTheme()
Events
Occurs when the Cancel button has been clicked.
public event EventHandler<NavigationButtonsEventArgs> Cancel
Occurs when the operation is completed.
public event EventHandler<WizardCompletedEventArgs> Completed
Occurs when the operation is about to be completed and allows you to cancel the operation.
public event EventHandler<WizardCompletingEventArgs> Completing
Occurs when the Finish button has been clicked.
public event EventHandler<NavigationButtonsEventArgs> Finish
Occurs when the Help button has been clicked.
public event EventHandler<NavigationButtonsEventArgs> Help
Occurs when the Next button has been clicked.
public event EventHandler<NavigationButtonsEventArgs> Next
Occurs when a new page is loaded.
public event EventHandler<PageEventArgs> PageLoaded
Occurs when the Previous button has been clicked.
public event EventHandler<NavigationButtonsEventArgs> Previous
Occurs when the selected page has changed.
public event EventHandler<SelectedPageChangedEventArgs> SelectionChanged
Occurs when the selected page is changing.
public event EventHandler<SelectedPageChangingEventArgs> SelectionChanging