Class RadWizard

RadWizard is a control which helps you to break a complex process into separate steps.

Inheritance
System.Object
RadWizard
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

[TelerikToolboxCategory("Navigation")]
public class RadWizard : Control, IThemable

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 CanCancelProperty
Field Value
System.Windows.DependencyProperty

The identifier for the CanCancel dependency property.

CanCancelPropertyKey

Identifies the CanCancel dependency property.

Declaration
public static readonly DependencyPropertyKey CanCancelPropertyKey
Field Value
System.Windows.DependencyPropertyKey

CanFinishProperty

Identifies the CanFinish dependency property.

Declaration
public static readonly DependencyProperty CanFinishProperty
Field Value
System.Windows.DependencyProperty

The identifier for the CanFinish dependency property.

CanFinishPropertyKey

Identifies the CanFinish dependency property.

Declaration
public static readonly DependencyPropertyKey CanFinishPropertyKey
Field Value
System.Windows.DependencyPropertyKey

CanHelpProperty

Identifies the CanHelp dependency property.

Declaration
public static readonly DependencyProperty CanHelpProperty
Field Value
System.Windows.DependencyProperty

The identifier for the CanHelp dependency property.

CanHelpPropertyKey

Identifies the CanHelp dependency property.

Declaration
public static readonly DependencyPropertyKey CanHelpPropertyKey
Field Value
System.Windows.DependencyPropertyKey

CanMoveCurrentToNextProperty

Identifies the CanMoveCurrentToNext dependency property.

Declaration
public static readonly DependencyProperty CanMoveCurrentToNextProperty
Field Value
System.Windows.DependencyProperty

The identifier for the CanMoveCurrentToNext dependency property.

CanMoveCurrentToNextPropertyKey

Identifies the CanMoveCurrentToNext dependency property.

Declaration
public static readonly DependencyPropertyKey CanMoveCurrentToNextPropertyKey
Field Value
System.Windows.DependencyPropertyKey

CanMoveCurrentToPreviousProperty

Identifies the CanMoveCurrentToPrevious dependency property.

Declaration
public static readonly DependencyProperty CanMoveCurrentToPreviousProperty
Field Value
System.Windows.DependencyProperty

The identifier for the CanMoveCurrentToPrevious dependency property.

CanMoveCurrentToPreviousPropertyKey

Identifies the CanMoveCurrentToPrevious dependency property.

Declaration
public static readonly DependencyPropertyKey CanMoveCurrentToPreviousPropertyKey
Field Value
System.Windows.DependencyPropertyKey

CommandProviderProperty

Represents the CommandProvider DependencyProperty.

Declaration
public static readonly DependencyProperty CommandProviderProperty
Field Value
System.Windows.DependencyProperty

DirectionProperty

Identifies the Direction DependencyProperty.

Declaration
public static readonly DependencyProperty DirectionProperty
Field Value
System.Windows.DependencyProperty

IsContentPreservedProperty

Represents the IsContentPreserved DependencyProperty.

Declaration
public static readonly DependencyProperty IsContentPreservedProperty
Field Value
System.Windows.DependencyProperty

SelectedPageIndexProperty

Represents the SelectedPageIndex DependencyProperty.

Declaration
public static readonly DependencyProperty SelectedPageIndexProperty
Field Value
System.Windows.DependencyProperty

SelectedPageProperty

Represents the SelectedPage DependencyProperty.

Declaration
public static readonly DependencyProperty SelectedPageProperty
Field Value
System.Windows.DependencyProperty

Properties

CanCancel

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

Declaration
public bool CanCancel { get; }
Property Value
System.Boolean

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
System.Boolean

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

CanHelp

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

Declaration
public bool CanHelp { get; }
Property Value
System.Boolean

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
System.Boolean

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
System.Boolean

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
WizardCommandProvider

IsContentPreserved

Gets or sets a value indicating whether the state of the content of WizardPage will be preserved when selection is changed.

Declaration
public bool IsContentPreserved { get; set; }
Property Value
System.Boolean

SelectedPage

Gets or sets the SelectedPage.

Declaration
public WizardPage SelectedPage { get; set; }
Property Value
WizardPage

SelectedPageIndex

Gets or sets the SelectedPageIndex.

Declaration
public int SelectedPageIndex { get; set; }
Property Value
System.Int32

WizardPages

Returns a collection of wizard's pages.

Declaration
public WizardPageCollection WizardPages { get; }
Property Value
WizardPageCollection

Methods

OnApplyTemplate()

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

Declaration
public override void OnApplyTemplate()

OnCancel(NavigationButtonsEventArgs)

Raises the Cancel event.

Declaration
protected virtual void OnCancel(NavigationButtonsEventArgs e)
Parameters
NavigationButtonsEventArgs e

OnCompleted(WizardCompletedEventArgs)

Raises the Completed event.

Declaration
protected virtual void OnCompleted(WizardCompletedEventArgs e)
Parameters
WizardCompletedEventArgs e

OnCompleting(WizardCompletingEventArgs)

Raises the Completing event.

Declaration
protected virtual void OnCompleting(WizardCompletingEventArgs e)
Parameters
WizardCompletingEventArgs e

OnCreateAutomationPeer()

Returns an automation peer for this RadWizard.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

OnFinish(NavigationButtonsEventArgs)

Raises the Finish event.

Declaration
protected virtual void OnFinish(NavigationButtonsEventArgs e)
Parameters
NavigationButtonsEventArgs e

OnHelp(NavigationButtonsEventArgs)

Raises the Help event.

Declaration
protected virtual void OnHelp(NavigationButtonsEventArgs e)
Parameters
NavigationButtonsEventArgs e

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Called when the root MouseLeftButtonDown event is fired.

Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

OnNext(NavigationButtonsEventArgs)

Raises the Next event.

Declaration
protected virtual void OnNext(NavigationButtonsEventArgs args)
Parameters
NavigationButtonsEventArgs args

OnPageLoaded(WizardPage)

Raises the PageLoaded event.

Declaration
protected virtual void OnPageLoaded(WizardPage page)
Parameters
WizardPage page

OnPrevious(NavigationButtonsEventArgs)

Raises the Previous event.

Declaration
protected virtual void OnPrevious(NavigationButtonsEventArgs args)
Parameters
NavigationButtonsEventArgs args

OnSelectionChanged(SelectedPageChangedEventArgs)

Raises the SelectionChanged event.

Declaration
protected virtual void OnSelectionChanged(SelectedPageChangedEventArgs e)
Parameters
SelectedPageChangedEventArgs e

OnSelectionChanging(SelectedPageChangingEventArgs)

Raises the SelectionChanging event.

Declaration
protected virtual void OnSelectionChanging(SelectedPageChangingEventArgs e)
Parameters
SelectedPageChangingEventArgs e

ResetTheme()

Resets the theme.

Declaration
public void ResetTheme()

Events

Cancel

Occurs when the Cancel button has been clicked.

Declaration
public event EventHandler<NavigationButtonsEventArgs> Cancel
Event Type
System.EventHandler<NavigationButtonsEventArgs>

Completed

Occurs when the operation is completed.

Declaration
public event EventHandler<WizardCompletedEventArgs> Completed
Event Type
System.EventHandler<WizardCompletedEventArgs>

Completing

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

Declaration
public event EventHandler<WizardCompletingEventArgs> Completing
Event Type
System.EventHandler<WizardCompletingEventArgs>

Finish

Occurs when the Finish button has been clicked.

Declaration
public event EventHandler<NavigationButtonsEventArgs> Finish
Event Type
System.EventHandler<NavigationButtonsEventArgs>

Help

Occurs when the Help button has been clicked.

Declaration
public event EventHandler<NavigationButtonsEventArgs> Help
Event Type
System.EventHandler<NavigationButtonsEventArgs>

Next

Occurs when the Next button has been clicked.

Declaration
public event EventHandler<NavigationButtonsEventArgs> Next
Event Type
System.EventHandler<NavigationButtonsEventArgs>

PageLoaded

Occurs when a new page is loaded.

Declaration
public event EventHandler<PageEventArgs> PageLoaded
Event Type
System.EventHandler<PageEventArgs>

Previous

Occurs when the Previous button has been clicked.

Declaration
public event EventHandler<NavigationButtonsEventArgs> Previous
Event Type
System.EventHandler<NavigationButtonsEventArgs>

SelectionChanged

Occurs when the selected page has changed.

Declaration
public event EventHandler<SelectedPageChangedEventArgs> SelectionChanged
Event Type
System.EventHandler<SelectedPageChangedEventArgs>

SelectionChanging

Occurs when the selected page is changing.

Declaration
public event EventHandler<SelectedPageChangingEventArgs> SelectionChanging
Event Type
System.EventHandler<SelectedPageChangingEventArgs>

Extension Methods