New to Telerik UI for WPFStart a free 30-day trial

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:

C#
[TelerikToolboxCategory("Navigation")]
public class RadWizard : Control

Inheritance: objectRadWizard

Constructors

Initializes a new instance of the RadWizard class.

C#
public RadWizard()

Fields

CanCancelProperty

DependencyProperty

Identifies the CanCancel dependency property.

C#
public static readonly DependencyProperty CanCancelProperty
Field Value:

The identifier for the CanCancel dependency property.

CanCancelPropertyKey

DependencyPropertyKey

Identifies the CanCancel dependency property.

C#
public static readonly DependencyPropertyKey CanCancelPropertyKey

CanFinishProperty

DependencyProperty

Identifies the CanFinish dependency property.

C#
public static readonly DependencyProperty CanFinishProperty
Field Value:

The identifier for the CanFinish dependency property.

CanFinishPropertyKey

DependencyPropertyKey

Identifies the CanFinish dependency property.

C#
public static readonly DependencyPropertyKey CanFinishPropertyKey

CanHelpProperty

DependencyProperty

Identifies the CanHelp dependency property.

C#
public static readonly DependencyProperty CanHelpProperty
Field Value:

The identifier for the CanHelp dependency property.

CanHelpPropertyKey

DependencyPropertyKey

Identifies the CanHelp dependency property.

C#
public static readonly DependencyPropertyKey CanHelpPropertyKey

Identifies the CanMoveCurrentToNext dependency property.

C#
public static readonly DependencyProperty CanMoveCurrentToNextProperty
Field Value:

The identifier for the CanMoveCurrentToNext dependency property.

CanMoveCurrentToNextPropertyKey

DependencyPropertyKey

Identifies the CanMoveCurrentToNext dependency property.

C#
public static readonly DependencyPropertyKey CanMoveCurrentToNextPropertyKey

Identifies the CanMoveCurrentToPrevious dependency property.

C#
public static readonly DependencyProperty CanMoveCurrentToPreviousProperty
Field Value:

The identifier for the CanMoveCurrentToPrevious dependency property.

Identifies the CanMoveCurrentToPrevious dependency property.

C#
public static readonly DependencyPropertyKey CanMoveCurrentToPreviousPropertyKey

CommandProviderProperty

DependencyProperty

Represents the CommandProvider DependencyProperty.

C#
public static readonly DependencyProperty CommandProviderProperty

DirectionProperty

DependencyProperty

Identifies the Direction DependencyProperty.

C#
public static readonly DependencyProperty DirectionProperty

IsContentPreservedProperty

DependencyProperty

Represents the IsContentPreserved DependencyProperty.

C#
public static readonly DependencyProperty IsContentPreservedProperty

SelectedPageIndexProperty

DependencyProperty

Represents the SelectedPageIndex DependencyProperty.

C#
public static readonly DependencyProperty SelectedPageIndexProperty

SelectedPageProperty

DependencyProperty

Represents the SelectedPage DependencyProperty.

C#
public static readonly DependencyProperty SelectedPageProperty

Properties

Gets a value that indicates whether the user can cancel the operation.

C#
public bool CanCancel { get; }
Property Value:

true if the user can cancel the operation; otherwise, false.

Gets a value that indicates whether the user can finish the operation.

C#
public bool CanFinish { get; }
Property Value:

true if the user can finish the operation; otherwise, false.

Gets a value that indicates whether the user can receive help.

C#
public bool CanHelp { get; }

Gets a value that indicates whether the user can move the current page to the next position.

C#
public bool CanMoveCurrentToNext { get; }
Property Value:

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.

C#
public bool CanMoveCurrentToPrevious { get; }
Property Value:

true if the user can move the current page to the previous position; otherwise, false.

Exposes a WizardCommandProvider.

C#
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.

C#
public bool IsContentPreserved { get; set; }

Gets or sets the SelectedPage.

C#
public WizardPage SelectedPage { get; set; }

Gets or sets the SelectedPageIndex.

C#
public int SelectedPageIndex { get; set; }

Returns a collection of wizard's pages.

C#
public WizardPageCollection WizardPages { get; }

Methods

When overridden in a derived class, is invoked whenever application code or internal processes call .

C#
public override void OnApplyTemplate()

Raises the Cancel event.

C#
protected virtual void OnCancel(NavigationButtonsEventArgs e)
Parameters:eNavigationButtonsEventArgs

Raises the Completed event.

C#
protected virtual void OnCompleted(WizardCompletedEventArgs e)
Parameters:eWizardCompletedEventArgs

Raises the Completing event.

C#
protected virtual void OnCompleting(WizardCompletingEventArgs e)
Parameters:eWizardCompletingEventArgs

Returns an automation peer for this RadWizard.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

Raises the Finish event.

C#
protected virtual void OnFinish(NavigationButtonsEventArgs e)
Parameters:eNavigationButtonsEventArgs

Raises the Help event.

C#
protected virtual void OnHelp(NavigationButtonsEventArgs e)
Parameters:eNavigationButtonsEventArgs

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

Called when the root MouseLeftButtonDown event is fired.

C#
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters:eMouseButtonEventArgs

Raises the Next event.

C#
protected virtual void OnNext(NavigationButtonsEventArgs args)
Parameters:argsNavigationButtonsEventArgs

Raises the PageLoaded event.

C#
protected virtual void OnPageLoaded(WizardPage page)
Parameters:pageWizardPage

Raises the Previous event.

C#
protected virtual void OnPrevious(NavigationButtonsEventArgs args)
Parameters:argsNavigationButtonsEventArgs

Raises the SelectionChanged event.

C#
protected virtual void OnSelectionChanged(SelectedPageChangedEventArgs e)
Parameters:eSelectedPageChangedEventArgs

Raises the SelectionChanging event.

C#
protected virtual void OnSelectionChanging(SelectedPageChangingEventArgs e)
Parameters:eSelectedPageChangingEventArgs

Resets the theme.

C#
public void ResetTheme()

Events

Occurs when the Cancel button has been clicked.

C#
public event EventHandler<NavigationButtonsEventArgs> Cancel

Occurs when the operation is completed.

C#
public event EventHandler<WizardCompletedEventArgs> Completed

Occurs when the operation is about to be completed and allows you to cancel the operation.

C#
public event EventHandler<WizardCompletingEventArgs> Completing

Occurs when the Finish button has been clicked.

C#
public event EventHandler<NavigationButtonsEventArgs> Finish

Occurs when the Help button has been clicked.

C#
public event EventHandler<NavigationButtonsEventArgs> Help

Occurs when the Next button has been clicked.

C#
public event EventHandler<NavigationButtonsEventArgs> Next

Occurs when a new page is loaded.

C#
public event EventHandler<PageEventArgs> PageLoaded

Occurs when the Previous button has been clicked.

C#
public event EventHandler<NavigationButtonsEventArgs> Previous

Occurs when the selected page has changed.

C#
public event EventHandler<SelectedPageChangedEventArgs> SelectionChanged

Occurs when the selected page is changing.

C#
public event EventHandler<SelectedPageChangingEventArgs> SelectionChanging