Wizard Class

[TemplatePart(Name = "PART_ButtonContainer", Type = typeof(WizardButtonContainer))]
[TemplatePart(Name = "PART_TransitionPresenter", Type = typeof(TransitionPresenter))]
public class Wizard : ItemsControl

public Wizard()

public bool? BackButtonEnabled { get; set; }

Property Value

bool?:

A Nullablebool specifying whether the Back button is enabled by default.

Remarks

If the value of this property is null, the Back button will be enabled when there is a valid WizardPage.PreviousPage set on the selected page or there is another enabled page before the selected page in sequential order.

[Localizability(LocalizationCategory.Text)]
public string? BackButtonText { get; set; }

Property Value

string

public bool BackButtonVisible { get; set; }

Property Value

bool:

true if the button should be visible by default; otherwise, false.

public Duration BackwardProgressTransitionDuration { get; set; }

Property Value

Duration

public WizardButtonContainer? ButtonContainer { get; }

Property Value

WizardButtonContainer

Remarks

This property corresponds to PART_ButtonContainer in the template.

public Thickness ButtonContainerPadding { get; set; }

Property Value

Thickness:

The default value is 7.

public bool CancelButtonClosesWindow { get; set; }

Property Value

bool:

true if Cancel button clicks automatically close the parent Window when the Cancel event is not cancelled; otherwise, false. The default value is true.

Remarks

If this property setting is true, and the IsWindowDialogResultUpdatingEnabled property is set to true, the Window.DialogResult property will be set to false immediately before the close.

public bool CancelButtonEnabled { get; set; }

Property Value

bool:

true if the button should be enabled by default; otherwise, false.

[Localizability(LocalizationCategory.Text)]
public string? CancelButtonText { get; set; }

Property Value

string

public bool CancelButtonVisible { get; set; }

Property Value

bool:

true if the button should be visible by default; otherwise, false.

public double ExteriorPageWatermarkMinWidth { get; set; }

Property Value

double

public bool FinishButtonClosesWindow { get; set; }

Property Value

bool:

true if Finish button clicks automatically close the parent Window when the Finish event is not cancelled; otherwise, false. The default value is true.

Remarks

If this property setting is true, and the IsWindowDialogResultUpdatingEnabled property is set to true, the Window.DialogResult property will be set to true immediately before the close.

public bool? FinishButtonEnabled { get; set; }

Property Value

bool?:

A Nullablebool specifying whether the Finish button is enabled by default.

Remarks

If the value of this property is null, the Finish button will be enabled when the last page in the wizard is the selected page.

[Localizability(LocalizationCategory.Text)]
public string? FinishButtonText { get; set; }

Property Value

string

public bool FinishButtonVisible { get; set; }

Property Value

bool:

true if the button should be visible by default; otherwise, false.

public Duration ForwardProgressTransitionDuration { get; set; }

Property Value

Duration

public bool HelpButtonEnabled { get; set; }

Property Value

bool:

true if the button should be enabled by default; otherwise, false.

[Localizability(LocalizationCategory.Text)]
public string? HelpButtonText { get; set; }

Property Value

string

public bool HelpButtonVisible { get; set; }

Property Value

bool:

true if the button should be visible by default; otherwise, false.

public double InteriorPageHeaderMinHeight { get; set; }

Property Value

double

public bool IsWindowDialogResultUpdatingEnabled { get; set; }

Property Value

bool:

true if the parent Window's DialogResult will be set when either the Cancel or Finish buttons are pressed; otherwise, false. The default value is false.

Remarks

This property is only used when the CancelButtonClosesWindow property is set to true.

If this property setting is true, the Window.DialogResult property will be set to false immediately before the close if the Cancel button is pressed. Likewise, the Window.DialogResult property will be set to true immediately before the close if the Finish button is pressed.

public bool NavigationCommandsEnabled { get; set; }

Property Value

bool:

true if page navigation using the commands is enabled; otherwise, false. The default value is true.

Remarks

When enabled and if using an extended mouse with a forward/back button configuration, pressing the mouse's forward button will execute the same action as clicking the wizard's Next button and pressing the mouse's back button will execute the same action as clicking the wizard's Back button.

public bool? NextButtonEnabled { get; set; }

Property Value

bool?:

A Nullablebool specifying whether the Next button is enabled by default.

Remarks

If the value of this property is null, the Next button will be enabled when there is a valid WizardPage.NextPage set on the selected page or there is another enabled page after the selected page in sequential order.

[Localizability(LocalizationCategory.Text)]
public string? NextButtonText { get; set; }

Property Value

string

public bool NextButtonVisible { get; set; }

Property Value

bool:

true if the button should be visible by default; otherwise, false.

public WizardPageSequenceType PageSequenceType { get; set; }

Property Value

WizardPageSequenceType

public int SelectedIndex { get; set; }

Property Value

int

public WizardPage? SelectedPage { get; set; }

Property Value

WizardPage

public TransitionDirection TransitionDefaultDirection { get; set; }

Property Value

TransitionDirection

Remarks

Most transitions do make use of a TransitionDirection, however not all do.

public TransitionSelector? TransitionSelector { get; set; }

Property Value

TransitionSelector

Remarks

By default, no transition is performed. Add a MultiTransitionSelector with one child Transition to only use one transition. Add a MultiTransitionSelector with more than one child Transition to randomly choose a transition to use.

public WizardWindowCancelButton WindowCancelButton { get; set; }

Property Value

WizardWindowCancelButton:

The default value is Cancel.

Remarks

Note that the target button must inherit the Button class.

public WizardWindowDefaultButton WindowDefaultButton { get; set; }

Property Value

WizardWindowDefaultButton:

The default value is FinishThenNext.

Remarks

Note that the target button must inherit the Button class.

[Localizability(LocalizationCategory.Title)]
public string? WindowTitleBaseText { get; set; }

Property Value

string

public WizardWindowTitleBehavior WindowTitleBehavior { get; set; }

Property Value

WizardWindowTitleBehavior:

The default value is None.

[Localizability(LocalizationCategory.Title)]
public string? WindowTitleCustomPageText { get; set; }

Property Value

string:

The default value is - Step {0} of {1}.

Remarks

This property is only used when WindowTitleBehavior is set to custom. It is passed as the format string to a string.Format call.

Multiple format items are passed in as parameters to this string.Format call. Index 0 is the current page index incremented by 1 for display purposes. Index 1 is the total number of pages. Both of these items are only useful for wizard that have a single linear execution path. Index 2 is the page title. Index 3 is the page caption. Index 4 is the page description.

public string? WindowTitleText { get; }

Property Value

string

Remarks

This property value is constructed based on the WindowTitleBaseText, WindowTitleBehavior, and WindowTitleCustomPageText properties.

public void BacktrackToPage(WizardPage page)

Parameter	Type	Description
page	WizardPage	The WizardPage to select.

See Also

• BacktrackToPreviousPage()
• GoToNextPage()
• GoToPage(WizardPage)

public void BacktrackToPreviousPage()

See Also

• BacktrackToPage(WizardPage)
• GoToNextPage()
• GoToPage(WizardPage)

public void ExecuteCancel()

public void ExecuteFinish()

public void ExecuteHelp()

protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject:

The element that is used to display the given item.

public void GoToNextPage()

See Also

• BacktrackToPage(WizardPage)
• BacktrackToPreviousPage()
• GoToPage(WizardPage)

public void GoToPage(WizardPage page)

Parameter	Type	Description
page	WizardPage	The WizardPage to select.

See Also

• BacktrackToPage(WizardPage)
• BacktrackToPreviousPage()
• GoToNextPage()

protected override bool IsItemItsOwnContainerOverride(object item)

Parameter	Type	Description
item	object	The item to check.

Returns

bool:

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

public override void OnApplyTemplate()

protected virtual void OnCancel(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	An RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

protected virtual void OnFinish(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	An RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameter	Type	Description
e	KeyboardFocusChangedEventArgs	The KeyboardFocusChangedEventArgs that contains the event data.

protected virtual void OnHelp(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	An RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnInitialized(EventArgs e)

Parameter	Type	Description
e	EventArgs	The RoutedEventArgs that contains the event data.

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameter	Type	Description
e	NotifyCollectionChangedEventArgs	Information about the change.

protected virtual void OnPreviewCancel(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	An RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnPreviewFinish(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	An RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnPreviewHelp(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	An RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnPreviewSelectedPageChanged(WizardSelectedPageChangeEventArgs e)

Parameter	Type	Description
e	WizardSelectedPageChangeEventArgs	An WizardSelectedPageChangeEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnPreviewSelectedPageChanging(WizardSelectedPageChangeEventArgs e)

Parameter	Type	Description
e	WizardSelectedPageChangeEventArgs	An WizardSelectedPageChangeEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnSelectedPageChanged(WizardSelectedPageChangeEventArgs e)

Parameter	Type	Description
e	WizardSelectedPageChangeEventArgs	An WizardSelectedPageChangeEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnSelectedPageChanging(WizardSelectedPageChangeEventArgs e)

Parameter	Type	Description
e	WizardSelectedPageChangeEventArgs	An WizardSelectedPageChangeEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnVisualParentChanged(DependencyObject oldParent)

Parameter	Type	Description
oldParent	DependencyObject	The old parent element. May be null to indicate that the element did not have a visual parent previously.

public void SetSelectedIndex(int index, WizardPageSelectionFlags newSelectionFlags)

Parameter	Type	Description
index	int	The index of the WizardPage to select.
newSelectionFlags	WizardPageSelectionFlags	A WizardPageSelectionFlags indicating information about the page selection.

public void SetSelectedPage(WizardPage page, WizardPageSelectionFlags newSelectionFlags)

Parameter	Type	Description
page	WizardPage	The WizardPage to select.
newSelectionFlags	WizardPageSelectionFlags	A WizardPageSelectionFlags indicating information about the page selection.

public void UpdateWindowTitle()

public event RoutedEventHandler Cancel

Event Type

RoutedEventHandler

public event RoutedEventHandler Finish

Event Type

RoutedEventHandler

public event RoutedEventHandler Help

Event Type

RoutedEventHandler

public event RoutedEventHandler PreviewCancel

Event Type

RoutedEventHandler

public event RoutedEventHandler PreviewFinish

Event Type

RoutedEventHandler

public event RoutedEventHandler PreviewHelp

Event Type

RoutedEventHandler

public event EventHandler<WizardSelectedPageChangeEventArgs> PreviewSelectedPageChanged

Event Type

EventHandler<WizardSelectedPageChangeEventArgs>

public event EventHandler<WizardSelectedPageChangeEventArgs> PreviewSelectedPageChanging

Event Type

EventHandler<WizardSelectedPageChangeEventArgs>

public event EventHandler<WizardSelectedPageChangeEventArgs> SelectedPageChanged

Event Type

EventHandler<WizardSelectedPageChangeEventArgs>

public event EventHandler<WizardSelectedPageChangeEventArgs> SelectedPageChanging

Event Type

EventHandler<WizardSelectedPageChangeEventArgs>

public static readonly DependencyProperty BackButtonEnabledProperty

public static readonly DependencyProperty BackButtonTextProperty

public static readonly DependencyProperty BackButtonVisibleProperty

public static readonly DependencyProperty BackwardProgressTransitionDurationProperty

public static readonly DependencyProperty ButtonContainerPaddingProperty

public static readonly DependencyProperty CancelButtonClosesWindowProperty

public static readonly DependencyProperty CancelButtonEnabledProperty

public static readonly DependencyProperty CancelButtonTextProperty

public static readonly DependencyProperty CancelButtonVisibleProperty

public static readonly RoutedEvent CancelEvent

public static readonly DependencyProperty ExteriorPageWatermarkMinWidthProperty

public static readonly DependencyProperty FinishButtonClosesWindowProperty

public static readonly DependencyProperty FinishButtonEnabledProperty

public static readonly DependencyProperty FinishButtonTextProperty

public static readonly DependencyProperty FinishButtonVisibleProperty

public static readonly RoutedEvent FinishEvent

public static readonly DependencyProperty ForwardProgressTransitionDurationProperty

public static readonly DependencyProperty HelpButtonEnabledProperty

public static readonly DependencyProperty HelpButtonTextProperty

public static readonly DependencyProperty HelpButtonVisibleProperty

public static readonly RoutedEvent HelpEvent

public static readonly DependencyProperty InteriorPageHeaderMinHeightProperty

public static readonly DependencyProperty IsWindowDialogResultUpdatingEnabledProperty

public static readonly DependencyProperty NavigationCommandsEnabledProperty

public static readonly DependencyProperty NextButtonEnabledProperty

public static readonly DependencyProperty NextButtonTextProperty

public static readonly DependencyProperty NextButtonVisibleProperty

public static readonly DependencyProperty PageSequenceTypeProperty

public static readonly RoutedEvent PreviewCancelEvent

public static readonly RoutedEvent PreviewFinishEvent

public static readonly RoutedEvent PreviewHelpEvent

public static readonly RoutedEvent PreviewSelectedPageChangedEvent

public static readonly RoutedEvent PreviewSelectedPageChangingEvent

public static readonly RoutedEvent SelectedPageChangedEvent

public static readonly RoutedEvent SelectedPageChangingEvent

public static readonly DependencyProperty SelectedPageProperty

public static readonly DependencyProperty TransitionDefaultDirectionProperty

public static readonly DependencyProperty TransitionSelectorProperty

public static readonly DependencyProperty WindowCancelButtonProperty

public static readonly DependencyProperty WindowDefaultButtonProperty

public static readonly DependencyProperty WindowTitleBaseTextProperty

public static readonly DependencyProperty WindowTitleBehaviorProperty

public static readonly DependencyProperty WindowTitleCustomPageTextProperty

public static readonly DependencyProperty WindowTitleTextProperty