ClassRadWizard
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 : ControlInheritance: objectRadWizard
Constructors
RadWizard()
Initializes a new instance of the RadWizard class.
Declaration
public RadWizard()Fields
CanCancelProperty
Identifies the CanCancel dependency property.
Declaration
public static readonly DependencyProperty CanCancelPropertyField Value
DependencyProperty
The identifier for the CanCancel dependency property.
CanCancelPropertyKey
Identifies the CanCancel dependency property.
Declaration
public static readonly DependencyPropertyKey CanCancelPropertyKeyField Value
DependencyPropertyKey
CanFinishProperty
Identifies the CanFinish dependency property.
Declaration
public static readonly DependencyProperty CanFinishPropertyField Value
DependencyProperty
The identifier for the CanFinish dependency property.
CanFinishPropertyKey
Identifies the CanFinish dependency property.
Declaration
public static readonly DependencyPropertyKey CanFinishPropertyKeyField Value
DependencyPropertyKey
CanHelpProperty
Identifies the CanHelp dependency property.
Declaration
public static readonly DependencyProperty CanHelpPropertyField Value
DependencyProperty
The identifier for the CanHelp dependency property.
CanHelpPropertyKey
Identifies the CanHelp dependency property.
Declaration
public static readonly DependencyPropertyKey CanHelpPropertyKeyField Value
DependencyPropertyKey
CanMoveCurrentToNextProperty
Identifies the CanMoveCurrentToNext dependency property.
Declaration
public static readonly DependencyProperty CanMoveCurrentToNextPropertyField Value
DependencyProperty
The identifier for the CanMoveCurrentToNext dependency property.
CanMoveCurrentToNextPropertyKey
Identifies the CanMoveCurrentToNext dependency property.
Declaration
public static readonly DependencyPropertyKey CanMoveCurrentToNextPropertyKeyField Value
DependencyPropertyKey
CanMoveCurrentToPreviousProperty
Identifies the CanMoveCurrentToPrevious dependency property.
Declaration
public static readonly DependencyProperty CanMoveCurrentToPreviousPropertyField Value
DependencyProperty
The identifier for the CanMoveCurrentToPrevious dependency property.
CanMoveCurrentToPreviousPropertyKey
Identifies the CanMoveCurrentToPrevious dependency property.
Declaration
public static readonly DependencyPropertyKey CanMoveCurrentToPreviousPropertyKeyField Value
DependencyPropertyKey
CommandProviderProperty
Represents the CommandProvider DependencyProperty.
Declaration
public static readonly DependencyProperty CommandProviderPropertyField Value
DependencyProperty
DirectionProperty
Identifies the Direction DependencyProperty.
Declaration
public static readonly DependencyProperty DirectionPropertyField Value
DependencyProperty
IsContentPreservedProperty
Represents the IsContentPreserved DependencyProperty.
Declaration
public static readonly DependencyProperty IsContentPreservedPropertyField Value
DependencyProperty
SelectedPageIndexProperty
Represents the SelectedPageIndex DependencyProperty.
Declaration
public static readonly DependencyProperty SelectedPageIndexPropertyField Value
DependencyProperty
SelectedPageProperty
Represents the SelectedPage DependencyProperty.
Declaration
public static readonly DependencyProperty SelectedPagePropertyField Value
DependencyProperty
Properties
CanCancel
Gets a value that indicates whether the user can cancel the operation.
Declaration
public bool CanCancel { get; }Property Value
true if the user can cancel the operation; otherwise, false.
CanFinish
Gets a value that indicates whether the user can finish the operation.
Declaration
public bool CanFinish { get; }Property Value
true if the user can finish the operation; otherwise, false.
CanHelp
Gets a value that indicates whether the user can receive help.
CanMoveCurrentToNext
Gets a value that indicates whether the user can move the current page to the next position.
Declaration
public bool CanMoveCurrentToNext { get; }Property Value
true if the user can move the current page to the next position; otherwise, false.
CanMoveCurrentToPrevious
Gets a value that indicates whether the user can move the current page to the previous position.
Declaration
public bool CanMoveCurrentToPrevious { get; }Property Value
true if the user can move the current page to the previous position; otherwise, false.
CommandProvider
Exposes a WizardCommandProvider.
Declaration
public WizardCommandProvider CommandProvider { get; set; }Property Value
IsContentPreserved
Gets or sets a value indicating whether the state of the content of WizardPage will be preserved when selection is changed.
SelectedPage
Gets or sets the SelectedPage.
Declaration
public WizardPage SelectedPage { get; set; }Property Value
SelectedPageIndex
Gets or sets the SelectedPageIndex.
WizardPages
Returns a collection of wizard's pages.
Declaration
public WizardPageCollection WizardPages { get; }Property Value
Methods
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call .
Declaration
public override void OnApplyTemplate()OnCancel(NavigationButtonsEventArgs)
Raises the Cancel event.
Declaration
protected virtual void OnCancel(NavigationButtonsEventArgs e)Parameters
e
OnCompleted(WizardCompletedEventArgs)
Raises the Completed event.
Declaration
protected virtual void OnCompleted(WizardCompletedEventArgs e)Parameters
e
OnCompleting(WizardCompletingEventArgs)
Raises the Completing event.
Declaration
protected virtual void OnCompleting(WizardCompletingEventArgs e)Parameters
e
OnCreateAutomationPeer()
Returns an automation peer for this RadWizard.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()Returns
AutomationPeer
OnFinish(NavigationButtonsEventArgs)
Raises the Finish event.
Declaration
protected virtual void OnFinish(NavigationButtonsEventArgs e)Parameters
e
OnHelp(NavigationButtonsEventArgs)
Raises the Help event.
Declaration
protected virtual void OnHelp(NavigationButtonsEventArgs e)Parameters
e
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)Parameters
e
The RoutedEventArgs that contains the event data.
OnMouseLeftButtonDown(MouseButtonEventArgs)
Called when the root MouseLeftButtonDown event is fired.
Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)Parameters
e
MouseButtonEventArgs
OnNext(NavigationButtonsEventArgs)
Raises the Next event.
Declaration
protected virtual void OnNext(NavigationButtonsEventArgs args)Parameters
args
OnPageLoaded(WizardPage)
Raises the PageLoaded event.
Declaration
protected virtual void OnPageLoaded(WizardPage page)Parameters
page
OnPrevious(NavigationButtonsEventArgs)
Raises the Previous event.
Declaration
protected virtual void OnPrevious(NavigationButtonsEventArgs args)Parameters
args
OnSelectionChanged(SelectedPageChangedEventArgs)
Raises the SelectionChanged event.
Declaration
protected virtual void OnSelectionChanged(SelectedPageChangedEventArgs e)Parameters
e
OnSelectionChanging(SelectedPageChangingEventArgs)
Raises the SelectionChanging event.
Declaration
protected virtual void OnSelectionChanging(SelectedPageChangingEventArgs e)Parameters
e
Events
Cancel
Occurs when the Cancel button has been clicked.
Declaration
public event EventHandler<NavigationButtonsEventArgs> CancelEvent Value
Completed
Occurs when the operation is completed.
Declaration
public event EventHandler<WizardCompletedEventArgs> CompletedEvent Value
Completing
Occurs when the operation is about to be completed and allows you to cancel the operation.
Declaration
public event EventHandler<WizardCompletingEventArgs> CompletingEvent Value
Finish
Occurs when the Finish button has been clicked.
Declaration
public event EventHandler<NavigationButtonsEventArgs> FinishEvent Value
Help
Occurs when the Help button has been clicked.
Declaration
public event EventHandler<NavigationButtonsEventArgs> HelpEvent Value
Next
Occurs when the Next button has been clicked.
Declaration
public event EventHandler<NavigationButtonsEventArgs> NextEvent Value
PageLoaded
Occurs when a new page is loaded.
Declaration
public event EventHandler<PageEventArgs> PageLoadedEvent Value
Previous
Occurs when the Previous button has been clicked.
Declaration
public event EventHandler<NavigationButtonsEventArgs> PreviousEvent Value
SelectionChanged
Occurs when the selected page has changed.
Declaration
public event EventHandler<SelectedPageChangedEventArgs> SelectionChangedEvent Value
SelectionChanging
Occurs when the selected page is changing.
Declaration
public event EventHandler<SelectedPageChangingEventArgs> SelectionChangingEvent Value