Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

WizardPage Class

Namespace:
ActiproSoftware.Windows.Controls.Wizard
Assembly:
ActiproSoftware.Wizard.Wpf.dll

Represents a page within a Wizard control.

[TemplatePart(Name = "PART_Header", Type = typeof(Panel))]
public class WizardPage : ContentControl, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, IAddChild
Inheritance:
Object DispatcherObject DependencyObject Visual UIElement FrameworkElement Control ContentControl Object

Remarks

For detailed documentation on this control's features and how to use them, please see the Wizard-related series of documentation topics.

Constructors

WizardPage()

public WizardPage()

Properties

BackButtonEnabled

Gets or sets the enabled state of the Back button when this page is selected.

public bool? BackButtonEnabled { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the enabled state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.BackButtonEnabled property will be used.

BackButtonVisibility

Gets the resolved Visibility of the Back button when this page is selected.

public Visibility BackButtonVisibility { get; }

Property Value

Visibility:

The resolved Visibility specifying the visible state of the button.
This value will be either Visible or Collapsed.

Remarks

This value first examines the BackButtonVisible property and if that is set to null, will examine the Wizard.BackButtonVisible property.

BackButtonVisible

Gets or sets the visible state of the Back button when this page is selected.

public bool? BackButtonVisible { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the visible state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.BackButtonVisible property will be used.

CancelButtonEnabled

Gets or sets the enabled state of the Cancel button when this page is selected.

public bool? CancelButtonEnabled { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the enabled state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.CancelButtonEnabled property will be used.

CancelButtonVisibility

Gets the resolved Visibility of the Cancel button when this page is selected.

public Visibility CancelButtonVisibility { get; }

Property Value

Visibility:

The resolved Visibility specifying the visible state of the button.
This value will be either Visible or Collapsed.

Remarks

This value first examines the CancelButtonVisible property and if that is set to null, will examine the Wizard.CancelButtonVisible property.

CancelButtonVisible

Gets or sets the visible state of the Cancel button when this page is selected.

public bool? CancelButtonVisible { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the visible state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.CancelButtonVisible property will be used.

Caption

Gets or sets the caption that is displayed in the page.

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

Property Value

String:

The caption that is displayed in the page.

Description

Gets or sets the description that is displayed in the page.

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

Property Value

String:

The description that is displayed in the page.

FinishButtonEnabled

Gets or sets the enabled state of the Finish button when this page is selected.

public bool? FinishButtonEnabled { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the enabled state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.FinishButtonEnabled property will be used.

FinishButtonVisibility

Gets the resolved Visibility of the Finish button when this page is selected.

public Visibility FinishButtonVisibility { get; }

Property Value

Visibility:

The resolved Visibility specifying the visible state of the button.
This value will be either Visible or Collapsed.

Remarks

This value first examines the FinishButtonVisible property and if that is set to null, will examine the Wizard.FinishButtonVisible property.

FinishButtonVisible

Gets or sets the visible state of the Finish button when this page is selected.

public bool? FinishButtonVisible { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the visible state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.FinishButtonVisible property will be used.

Header

Gets the Panel that represents the header in the template.

public Panel Header { get; }

Property Value

Panel:

The Panel that represents the header in the template.

Remarks

This property corresponds to PART_Header in the template.

HeaderBackground

Gets or sets the Brush used to draw the background that is displayed in the page header.

public Brush HeaderBackground { get; set; }

Property Value

Brush:

The Brush used to draw the background that is displayed in the page header.

HeaderImage

Gets or sets the ImageSource that is displayed at the right side of the page header.

public ImageSource HeaderImage { get; set; }

Property Value

ImageSource:

The ImageSource that is displayed at the right side of the page header.

HeaderImageMargin

Gets or sets the margin thickness around the HeaderImage.

public Thickness HeaderImageMargin { get; set; }

Property Value

Thickness:

The margin thickness around the HeaderImage. The default value is 4 for interior pages and 18 for exterior pages.

HelpButtonEnabled

Gets or sets the enabled state of the Help button when this page is selected.

public bool? HelpButtonEnabled { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the enabled state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.HelpButtonEnabled property will be used.

HelpButtonVisibility

Gets the resolved Visibility of the Help button when this page is selected.

public Visibility HelpButtonVisibility { get; }

Property Value

Visibility:

The resolved Visibility specifying the visible state of the button.
This value will be either Visible or Collapsed.

Remarks

This value first examines the HelpButtonVisible property and if that is set to null, will examine the Wizard.HelpButtonVisible property.

HelpButtonVisible

Gets or sets the visible state of the Help button when this page is selected.

public bool? HelpButtonVisible { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the visible state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.HelpButtonVisible property will be used.

IsSelected

Gets or sets whether the page is selected.

public bool IsSelected { get; set; }

Property Value

Boolean:

true if the page is selected; otherwise, false.

NextButtonEnabled

Gets or sets the enabled state of the Next button when this page is selected.

public bool? NextButtonEnabled { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the enabled state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.NextButtonEnabled property will be used.

NextButtonVisibility

Gets the resolved Visibility of the Next button when this page is selected.

public Visibility NextButtonVisibility { get; }

Property Value

Visibility:

The resolved Visibility specifying the visible state of the button.
This value will be either Visible or Collapsed.

Remarks

This value first examines the NextButtonVisible property and if that is set to null, will examine the Wizard.NextButtonVisible property.

NextButtonVisible

Gets or sets the visible state of the Next button when this page is selected.

public bool? NextButtonVisible { get; set; }

Property Value

Nullable<Boolean>:

A Nullable Boolean specifying the visible state of the button.

Remarks

If the value of this property is null, the default value and logic specified by the Wizard.NextButtonVisible property will be used.

NextPage

Gets or sets the next WizardPage to visit when the NextPage is executed.

public object NextPage { get; set; }

Property Value

Object:

The next WizardPage to visit when the NextPage is executed.

Remarks

Leave this property null to simply move to the next page in sequential order. This property can be set to three different types of data, thus the property returns an Object. Possible values are a reference to a WizardPage within the parent Wizard, the name of another WizardPage within the parent Wizard, or an integer indicating the index of a WizardPage within the parent Wizard.

PageType

Gets or sets the type of page, which helps control the style used to render the page.

public WizardPageType PageType { get; set; }

Property Value

WizardPageType:

A WizardPageType specifying the type of page.

PreviousPage

Gets or sets the previous WizardPage to visit when the PreviousPage is executed.

public object PreviousPage { get; set; }

Property Value

Object:

The previous WizardPage to visit when the PreviousPage is executed.

Remarks

Leave this property null to simply move to the previous page in sequential order. This property can be set to three different types of data, thus the property returns an Object. Possible values are a reference to a WizardPage within the parent Wizard, the name of another WizardPage within the parent Wizard, or an integer indicating the index of a WizardPage within the parent Wizard.

Note that this property will have no effect if the Wizard.PageSequenceType property is set to Stack.

Title

Gets or sets the title that is displayed in the containing Window control's title if the WindowTitleBehavior is set to PageTitle.

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

Property Value

String:

The title that is displayed in the containing Window control's title if the WindowTitleBehavior is set to PageTitle.

Wizard

Gets the Wizard control that is the parent of the page.

public Wizard Wizard { get; }

Property Value

Wizard:

The Wizard control that is the parent of the page.

Methods

OnCancel(RoutedEventArgs)

Raises the CancelEvent event.

protected virtual void OnCancel(RoutedEventArgs e)
Parameter Type Description
e RoutedEventArgs

A RoutedEventArgs that contains the event data.

OnCreateAutomationPeer()

Creates and returns an AutomationPeer object for this type.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The AutomationPeer that was created.

OnFinish(RoutedEventArgs)

Raises the FinishEvent event.

protected virtual void OnFinish(RoutedEventArgs e)
Parameter Type Description
e RoutedEventArgs

A RoutedEventArgs that contains the event data.

OnHelp(RoutedEventArgs)

Raises the HelpEvent event.

protected virtual void OnHelp(RoutedEventArgs e)
Parameter Type Description
e RoutedEventArgs

An EventArgs that contains the event data.

OnSelected(WizardSelectedPageChangeEventArgs)

Raises the SelectedEvent event.

protected virtual void OnSelected(WizardSelectedPageChangeEventArgs e)
Parameter Type Description
e WizardSelectedPageChangeEventArgs

A WizardSelectedPageChangeEventArgs that contains the event data.

OnSelecting(WizardSelectedPageChangeEventArgs)

Raises the SelectingEvent event.

protected virtual void OnSelecting(WizardSelectedPageChangeEventArgs e)
Parameter Type Description
e WizardSelectedPageChangeEventArgs

A WizardSelectedPageChangeEventArgs that contains the event data.

OnUnselected(WizardSelectedPageChangeEventArgs)

Raises the UnselectedEvent event.

protected virtual void OnUnselected(WizardSelectedPageChangeEventArgs e)
Parameter Type Description
e WizardSelectedPageChangeEventArgs

A WizardSelectedPageChangeEventArgs that contains the event data.

OnUnselecting(WizardSelectedPageChangeEventArgs)

Raises the UnselectingEvent event.

protected virtual void OnUnselecting(WizardSelectedPageChangeEventArgs e)
Parameter Type Description
e WizardSelectedPageChangeEventArgs

A WizardSelectedPageChangeEventArgs that contains the event data.

ToString()

Returns a String that represents the current Object.

public override string ToString()

Returns

String:

A String that represents the current Object.

Events

Cancel

Occurs when the wizard is cancelled while this page is selected, generally via a Cancel button click.

public event RoutedEventHandler Cancel

Event Type

RoutedEventHandler

Finish

Occurs when the wizard is finished while this page is selected, generally via a Finish button click.

public event RoutedEventHandler Finish

Event Type

RoutedEventHandler

Help

Occurs when help is requested for the wizard while this page is selected, generally via a Help button click.

public event RoutedEventHandler Help

Event Type

RoutedEventHandler

Selected

Occurs after this page is selected.

public event EventHandler<WizardSelectedPageChangeEventArgs> Selected

Event Type

EventHandler<WizardSelectedPageChangeEventArgs>

Selecting

Occurs before this page is selected.

public event EventHandler<WizardSelectedPageChangeEventArgs> Selecting

Event Type

EventHandler<WizardSelectedPageChangeEventArgs>

Unselected

Occurs after this page is unselected.

public event EventHandler<WizardSelectedPageChangeEventArgs> Unselected

Event Type

EventHandler<WizardSelectedPageChangeEventArgs>

Unselecting

Occurs before this page is unselected.

public event EventHandler<WizardSelectedPageChangeEventArgs> Unselecting

Event Type

EventHandler<WizardSelectedPageChangeEventArgs>

Fields

BackButtonEnabledProperty

Identifies the BackButtonEnabled dependency property. This field is read-only.

public static readonly DependencyProperty BackButtonEnabledProperty

BackButtonVisibilityProperty

Identifies the BackButtonVisibility dependency property. This field is read-only.

public static readonly DependencyProperty BackButtonVisibilityProperty

BackButtonVisibleProperty

Identifies the BackButtonVisible dependency property. This field is read-only.

public static readonly DependencyProperty BackButtonVisibleProperty

CancelButtonEnabledProperty

Identifies the CancelButtonEnabled dependency property. This field is read-only.

public static readonly DependencyProperty CancelButtonEnabledProperty

CancelButtonVisibilityProperty

Identifies the CancelButtonVisibility dependency property. This field is read-only.

public static readonly DependencyProperty CancelButtonVisibilityProperty

CancelButtonVisibleProperty

Identifies the CancelButtonVisible dependency property. This field is read-only.

public static readonly DependencyProperty CancelButtonVisibleProperty

CancelEvent

Identifies the Cancel routed event. This field is read-only.

public static readonly RoutedEvent CancelEvent

CaptionProperty

Identifies the Caption dependency property. This field is read-only.

public static readonly DependencyProperty CaptionProperty

DescriptionProperty

Identifies the Description dependency property. This field is read-only.

public static readonly DependencyProperty DescriptionProperty

FinishButtonEnabledProperty

Identifies the FinishButtonEnabled dependency property. This field is read-only.

public static readonly DependencyProperty FinishButtonEnabledProperty

FinishButtonVisibilityProperty

Identifies the FinishButtonVisibility dependency property. This field is read-only.

public static readonly DependencyProperty FinishButtonVisibilityProperty

FinishButtonVisibleProperty

Identifies the FinishButtonVisible dependency property. This field is read-only.

public static readonly DependencyProperty FinishButtonVisibleProperty

FinishEvent

Identifies the Finish routed event. This field is read-only.

public static readonly RoutedEvent FinishEvent

HeaderBackgroundProperty

Identifies the HeaderBackground dependency property. This field is read-only.

public static readonly DependencyProperty HeaderBackgroundProperty

HeaderImageMarginProperty

Identifies the HeaderImageMargin dependency property. This field is read-only.

public static readonly DependencyProperty HeaderImageMarginProperty

HeaderImageProperty

Identifies the HeaderImage dependency property. This field is read-only.

public static readonly DependencyProperty HeaderImageProperty

HelpButtonEnabledProperty

Identifies the HelpButtonEnabled dependency property. This field is read-only.

public static readonly DependencyProperty HelpButtonEnabledProperty

HelpButtonVisibilityProperty

Identifies the HelpButtonVisibility dependency property. This field is read-only.

public static readonly DependencyProperty HelpButtonVisibilityProperty

HelpButtonVisibleProperty

Identifies the HelpButtonVisible dependency property. This field is read-only.

public static readonly DependencyProperty HelpButtonVisibleProperty

HelpEvent

Identifies the Help routed event. This field is read-only.

public static readonly RoutedEvent HelpEvent

NextButtonEnabledProperty

Identifies the NextButtonEnabled dependency property. This field is read-only.

public static readonly DependencyProperty NextButtonEnabledProperty

NextButtonVisibilityProperty

Identifies the NextButtonVisibility dependency property. This field is read-only.

public static readonly DependencyProperty NextButtonVisibilityProperty

NextButtonVisibleProperty

Identifies the NextButtonVisible dependency property. This field is read-only.

public static readonly DependencyProperty NextButtonVisibleProperty

NextPageProperty

Identifies the NextPage dependency property. This field is read-only.

public static readonly DependencyProperty NextPageProperty

PageTypeProperty

Identifies the PageType dependency property. This field is read-only.

public static readonly DependencyProperty PageTypeProperty

PreviousPageProperty

Identifies the PreviousPage dependency property. This field is read-only.

public static readonly DependencyProperty PreviousPageProperty

SelectedEvent

Identifies the Selected routed event. This field is read-only.

public static readonly RoutedEvent SelectedEvent

SelectingEvent

Identifies the Selecting routed event. This field is read-only.

public static readonly RoutedEvent SelectingEvent

TitleProperty

Identifies the Title dependency property. This field is read-only.

public static readonly DependencyProperty TitleProperty

UnselectedEvent

Identifies the Unselected routed event. This field is read-only.

public static readonly RoutedEvent UnselectedEvent

UnselectingEvent

Identifies the Unselecting routed event. This field is read-only.

public static readonly RoutedEvent UnselectingEvent

Inherited Members

Extension Methods