Class WizardControl

A WizardControl that implements a classic Wizard UI. Add WizardPages to the control and switch between the pages using the Next, Back, etc. buttons. Navigation and look and feel is fully customizable

Inheritance

System.Object

WizardControl

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
public class WizardControl : ItemsControl

Examples

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;
using Syncfusion.Windows.Tools.Controls;
namespace wizardControl
{
    /// 

    /// Interaction logic for Window1.xaml
    /// 
    public partial class Window1 : Window
    {
        public Window1()
        {
            InitializeComponent();
            WizardControl wizardControl = new WizardControl();
            this.Content = wizardControl;
        }
    }
}

Constructors

WizardControl()

Initializes a new instance of the WizardControl class.

Declaration

public WizardControl()

Fields

BackEnabledProperty

Identifies the BackEnabled property.

Declaration

public static readonly DependencyProperty BackEnabledProperty

Field Value

Type
System.Windows.DependencyProperty

BackTextProperty

Identifies the BackText property.

Declaration

public static readonly DependencyProperty BackTextProperty

Field Value

Type
System.Windows.DependencyProperty

BackVisibleProperty

Identifies the BackVisible property.

Declaration

public static readonly DependencyProperty BackVisibleProperty

Field Value

Type
System.Windows.DependencyProperty

CancelButtonCancelsWindowProperty

Identifies the CancelButtonCancelsWindow property.

Declaration

public static readonly DependencyProperty CancelButtonCancelsWindowProperty

Field Value

Type
System.Windows.DependencyProperty

CancelEnabledProperty

Identifies the CancelEnabled property.

Declaration

public static readonly DependencyProperty CancelEnabledProperty

Field Value

Type
System.Windows.DependencyProperty

CancelEvent

Identifies Cancel routed event.

Declaration

public static readonly RoutedEvent CancelEvent

Field Value

Type
System.Windows.RoutedEvent

CancelSPCEventsOnItemsSourceChangedProperty

Identifies the property.

Declaration

public static readonly DependencyProperty CancelSPCEventsOnItemsSourceChangedProperty

Field Value

Type
System.Windows.DependencyProperty

CancelTextProperty

Identifies the CancelText property.

Declaration

public static readonly DependencyProperty CancelTextProperty

Field Value

Type
System.Windows.DependencyProperty

CancelVisibleProperty

Identifies the CancelVisible property.

Declaration

public static readonly DependencyProperty CancelVisibleProperty

Field Value

Type
System.Windows.DependencyProperty

EnsureDefaultSelectionProperty

Identifies the EnsureDefaultSelection property.

Declaration

public static readonly DependencyProperty EnsureDefaultSelectionProperty

Field Value

Type
System.Windows.DependencyProperty

ExteriorPageBannerImageMinWidthProperty

Identifies the ExteriorPageBannerImageMinWidth property.

Declaration

public static readonly DependencyProperty ExteriorPageBannerImageMinWidthProperty

Field Value

Type
System.Windows.DependencyProperty

FinishButtonClosesWindowProperty

Identifies the FinishButtonClosesWindow property.

Declaration

public static readonly DependencyProperty FinishButtonClosesWindowProperty

Field Value

Type
System.Windows.DependencyProperty

FinishEnabledProperty

Identifies the FinishEnabled property.

Declaration

public static readonly DependencyProperty FinishEnabledProperty

Field Value

Type
System.Windows.DependencyProperty

FinishEvent

Identifies Finish routed event.

Declaration

public static readonly RoutedEvent FinishEvent

Field Value

Type
System.Windows.RoutedEvent

FinishFocusedProperty

Identifies the FinishFocused property.

Declaration

public static readonly DependencyProperty FinishFocusedProperty

Field Value

Type
System.Windows.DependencyProperty

FinishTextProperty

Identifies the FinishText property.

Declaration

public static readonly DependencyProperty FinishTextProperty

Field Value

Type
System.Windows.DependencyProperty

FinishVisibleProperty

Identifies the FinishVisible property.

Declaration

public static readonly DependencyProperty FinishVisibleProperty

Field Value

Type
System.Windows.DependencyProperty

HelpEvent

Identifies Help routed event.

Declaration

public static readonly RoutedEvent HelpEvent

Field Value

Type
System.Windows.RoutedEvent

HelpTextProperty

Identifies the HelpText property.

Declaration

public static readonly DependencyProperty HelpTextProperty

Field Value

Type
System.Windows.DependencyProperty

HelpVisibleProperty

Identifies the HelpVisible property.

Declaration

public static readonly DependencyProperty HelpVisibleProperty

Field Value

Type
System.Windows.DependencyProperty

InteriorPageHeaderMinHeightProperty

Identifies the InteriorPageHeaderMinHeight property.

Declaration

public static readonly DependencyProperty InteriorPageHeaderMinHeightProperty

Field Value

Type
System.Windows.DependencyProperty

NextAndFinishAreDefaultButtonsProperty

Identifies the NextAndFinishAreDefaultButtons property.

Declaration

public static readonly DependencyProperty NextAndFinishAreDefaultButtonsProperty

Field Value

Type
System.Windows.DependencyProperty

NextEnabledProperty

Identifies the NextEnabled property.

Declaration

public static readonly DependencyProperty NextEnabledProperty

Field Value

Type
System.Windows.DependencyProperty

NextEvent

Identifies Help routed event.

Declaration

public static readonly RoutedEvent NextEvent

Field Value

Type
System.Windows.RoutedEvent

NextFocusedProperty

Identifies the NextFocused property.

Declaration

public static readonly DependencyProperty NextFocusedProperty

Field Value

Type
System.Windows.DependencyProperty

NextTextProperty

Identifies the NextText property.

Declaration

public static readonly DependencyProperty NextTextProperty

Field Value

Type
System.Windows.DependencyProperty

NextVisibleProperty

Identifies the NextVisible property.

Declaration

public static readonly DependencyProperty NextVisibleProperty

Field Value

Type
System.Windows.DependencyProperty

SelectedPageChangedEvent

Identifies SelectedPageChanged routed event.

Declaration

public static readonly RoutedEvent SelectedPageChangedEvent

Field Value

Type
System.Windows.RoutedEvent

SelectedPageChangingEvent

Identifies SelectedPageChanging routed event.

Declaration

public static readonly RoutedEvent SelectedPageChangingEvent

Field Value

Type
System.Windows.RoutedEvent

SelectedWizardPageProperty

Identifies the SelectedWizardPage property.

Declaration

public static readonly DependencyProperty SelectedWizardPageProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

BackEnabled

Gets or sets the back enabled.

Declaration

public Nullable<bool> BackEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The back enabled.

BackText

Gets or sets the back text.

Declaration

public string BackText { get; set; }

Property Value

Type	Description
System.String	The back text.

BackVisible

Gets or sets a value indicating whether [back visible].

Declaration

public bool BackVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if [back visible]; otherwise, false.

CancelButtonCancelsWindow

Gets or sets a value indicating whether [cancel button cancels window].

Declaration

public bool CancelButtonCancelsWindow { get; set; }

Property Value

Type	Description
System.Boolean	true if [cancel button cancels window]; otherwise, false.

CancelEnabled

Gets or sets a value indicating whether [cancel enabled].

Declaration

public bool CancelEnabled { get; set; }

Property Value

Type	Description
System.Boolean	true if [cancel enabled]; otherwise, false.

CancelSPCEventsOnItemsSourceChanged

Gets or sets value indicates to cancel the selected page changing event.

Declaration

public bool CancelSPCEventsOnItemsSourceChanged { get; set; }

Property Value

Type
System.Boolean

CancelText

Gets or sets the cancel text.

Declaration

public string CancelText { get; set; }

Property Value

Type	Description
System.String	The cancel text.

CancelVisible

Gets or sets a value indicating whether [cancel visible].

Declaration

public bool CancelVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if [cancel visible]; otherwise, false.

EnsureDefaultSelection

Gets or sets a value indicating whether [ensure default selection].

Declaration

public bool EnsureDefaultSelection { get; set; }

Property Value

Type	Description
System.Boolean	true if [ensure default selection]; otherwise, false.

ExteriorPageBannerImageMinWidth

Gets or sets the width of the exterior page banner image min.

Declaration

public double ExteriorPageBannerImageMinWidth { get; set; }

Property Value

Type	Description
System.Double	The width of the exterior page banner image min.

FinishButtonClosesWindow

Gets or sets a value indicating whether [finish button closes window].

Declaration

public bool FinishButtonClosesWindow { get; set; }

Property Value

Type	Description
System.Boolean	true if [finish button closes window]; otherwise, false.

FinishEnabled

Gets or sets the finish enabled.

Declaration

public Nullable<bool> FinishEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The finish enabled.

FinishFocused

Gets or sets a value indicating whether [finish focused].

Declaration

public bool FinishFocused { get; set; }

Property Value

Type	Description
System.Boolean	true if [finish focused]; otherwise, false.

FinishText

Gets or sets the finish text.

Declaration

public string FinishText { get; set; }

Property Value

Type	Description
System.String	The finish text.

FinishVisible

Gets or sets a value indicating whether [finish visible].

Declaration

public bool FinishVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if [finish visible]; otherwise, false.

HelpText

Gets or sets the help text.

Declaration

public string HelpText { get; set; }

Property Value

Type	Description
System.String	The help text.

HelpVisible

Gets or sets a value indicating whether [help visible].

Declaration

public bool HelpVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if [help visible]; otherwise, false.

InteriorPageHeaderMinHeight

Gets or sets the height of the interior page header min.

Declaration

public double InteriorPageHeaderMinHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the interior page header min.

NextAndFinishAreDefaultButtons

Gets or sets a value indicating whether [next and finish are default buttons].

Declaration

public bool NextAndFinishAreDefaultButtons { get; set; }

Property Value

Type	Description
System.Boolean	true if [next and finish are default buttons]; otherwise, false.

NextEnabled

Gets or sets the next enabled.

Declaration

public Nullable<bool> NextEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The next enabled.

NextFocused

Gets or sets a value indicating whether [next focused].

Declaration

public bool NextFocused { get; set; }

Property Value

Type	Description
System.Boolean	true if [next focused]; otherwise, false.

NextText

Gets or sets the next text.

Declaration

public string NextText { get; set; }

Property Value

Type	Description
System.String	The next text.

NextVisible

Gets or sets a value indicating whether [next visible].

Declaration

public bool NextVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if [next visible]; otherwise, false.

SelectedWizardPage

Gets or sets the selected wizard page.

Declaration

public WizardPage SelectedWizardPage { get; set; }

Property Value

Type	Description
WizardPage	The selected wizard page.

Methods

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

Declaration

protected override DependencyObject GetContainerForItemOverride()

Returns

Type	Description
System.Windows.DependencyObject	The element that is used to display the given item.

IsItemItsOwnContainerOverride(Object)

Determines if the specified item is (or is eligible to be) its own container.

Declaration

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

Type	Name	Description
System.Object	item	The item to check.

Returns

Type	Description
System.Boolean	true if the item is (or is eligible to be) its own container; otherwise, false.

Items_CurrentChanged(Object, EventArgs)

Handles the CurrentChanged event of the Items control.

Declaration

protected void Items_CurrentChanged(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The source of the event.
System.EventArgs	e	The System.EventArgs instance containing the event data.

MoveFirst()

Moves the first.

Declaration

public void MoveFirst()

MoveLast()

Moves the last.

Declaration

public void MoveLast()

MoveNext()

Moves the next.

Declaration

public void MoveNext()

MovePrevious()

Moves the previous.

Declaration

public void MovePrevious()

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoked when the System.Windows.Controls.ItemsControl.Items property changes.

Declaration

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

Type	Name	Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e	Information about the change.

OnItemsSourceChanged(IEnumerable, IEnumerable)

invoked when changes in the ItemsSource collection.

Declaration

protected override void OnItemsSourceChanged(IEnumerable oldValue, IEnumerable newValue)

Parameters

Type	Name	Description
System.Collections.IEnumerable	oldValue
System.Collections.IEnumerable	newValue

OnKeyDown(KeyEventArgs)

Invoked when the System.Windows.UIElement.KeyDown event is received.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyEventArgs	e	Information about the event.

ValidateNewPage(WizardPageSelectionChangeCause, WizardPage)

Validates the change in selection by firing the Unselecting, SelectedPageChanging and the Selecting events.

Declaration

protected bool ValidateNewPage(WizardPageSelectionChangeCause cause, WizardPage newPage)

Parameters

Type	Name	Description
WizardPageSelectionChangeCause	cause	Specifies what caused the change in selection.
WizardPage	newPage	The new page that is to be selected.

Returns

Type	Description
System.Boolean	True if validation succeeds, false otherwise.

Events

Cancel

Bubbling routed event, fired when the Cancel button was clicked.

Declaration

public event RoutedEventHandler Cancel

Event Type

Type
System.Windows.RoutedEventHandler

Finish

Bubbling routed event, fired when the Finish button was clicked.

Declaration

public event RoutedEventHandler Finish

Event Type

Type
System.Windows.RoutedEventHandler

Help

Bubbling routed event, fired when the Help button was clicked.

Declaration

public event RoutedEventHandler Help

Event Type

Type
System.Windows.RoutedEventHandler

Next

Bubbling routed event, fired when the Next button was clicked.

Declaration

public event RoutedEventHandler Next

Event Type

Type
System.Windows.RoutedEventHandler

SelectedPageChanged

Bubbling routed event, fired when the selected page changed.

Declaration

public event RoutedEventHandler SelectedPageChanged

Event Type

Type
System.Windows.RoutedEventHandler

SelectedPageChanging

Bubbling routed event, fired when the selected page is changing

Declaration

public event EventHandler<WizardPageSelectionChangeEventArgs> SelectedPageChanging

Event Type

Type
System.EventHandler<WizardPageSelectionChangeEventArgs>