Class RadWizardElement

Encapsulates the UI representation and functionality of RadWizard. This class provides the core element implementation for the wizard control, managing pages, navigation, and view modes.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadWizardElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadWizardElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadWizardElement()

Initializes a new instance of the RadWizardElement class and sets up the event handlers for page collection changes.

Declaration
public RadWizardElement()

Fields

EnableAeroStyleProperty

Identifies the EnableAeroStyle dependency property that controls whether Aero styling is applied when the wizard is in Aero mode.

Declaration
public static RadProperty EnableAeroStyleProperty
Field Value
RadProperty

Properties

BackButton

Gets the Back button element from the command area that allows navigation to the previous wizard page.

Declaration
public RadButtonElement BackButton { get; }
Property Value
RadButtonElement

CancelButton

Gets the Cancel button element from the command area that allows the user to cancel the wizard operation.

Declaration
public WizardCommandAreaButtonElement CancelButton { get; }
Property Value
WizardCommandAreaButtonElement

CommandArea

Gets the command area element that contains the navigation buttons (Back, Next, Cancel, Finish, Help) for the wizard.

Declaration
public WizardCommandArea CommandArea { get; }
Property Value
WizardCommandArea

CommandAreaHeight

Gets or sets the height of the command area in pixels. A negative value allows the command area to automatically size itself.

Declaration
public float CommandAreaHeight { get; set; }
Property Value
System.Single

CompletionImage

Gets or sets the background image displayed on completion pages. This serves as the default image when individual completion pages don't specify their own image.

Declaration
public Image CompletionImage { get; set; }
Property Value
System.Drawing.Image

CompletionImageBackgroundShape

Gets or sets the background image shape configuration for completion pages, which controls advanced image rendering and styling options.

Declaration
public RadImageShape CompletionImageBackgroundShape { get; set; }
Property Value
RadImageShape

CompletionImageElement

Gets the visual element that displays the background image for completion pages.

Declaration
public LightVisualElement CompletionImageElement { get; }
Property Value
LightVisualElement

CompletionImageLayout

Gets or sets the layout mode for the completion page background image, determining how the image is positioned and scaled within its container.

Declaration
public ImageLayout CompletionImageLayout { get; set; }
Property Value
System.Windows.Forms.ImageLayout

CompletionPage

Gets or sets the completion page that typically appears as the final page in the wizard sequence.

Declaration
public WizardCompletionPage CompletionPage { get; set; }
Property Value
WizardCompletionPage

EnableAeroStyle

Gets or sets a value indicating whether the Aero visual style should be applied when the wizard is in Aero mode.

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

FinishButton

Gets the Finish button element from the command area that allows the user to complete the wizard operation.

Declaration
public WizardCommandAreaButtonElement FinishButton { get; }
Property Value
WizardCommandAreaButtonElement

HelpButton

Gets the Help button element from the command area that provides access to help information.

Declaration
public LightVisualElement HelpButton { get; }
Property Value
LightVisualElement

HideCompletionImage

Gets or sets a value indicating whether the completion page background image should be hidden from display.

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

HideWelcomeImage

Gets or sets a value indicating whether the welcome page background image should be hidden from display.

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

Mode

Gets or sets the display mode of the wizard, which determines the visual style and behavior of the wizard interface.

Declaration
public WizardMode Mode { get; set; }
Property Value
WizardMode

NextButton

Gets the Next button element from the command area that allows navigation to the next wizard page.

Declaration
public WizardCommandAreaButtonElement NextButton { get; }
Property Value
WizardCommandAreaButtonElement

OwnerControl

Gets the RadWizard control that owns this element instance.

Declaration
public RadWizard OwnerControl { get; }
Property Value
RadWizard

PageHeaderElement

Gets the page header element that displays the title, description, and icon for the current wizard page.

Declaration
public WizardPageHeaderElement PageHeaderElement { get; }
Property Value
WizardPageHeaderElement

PageHeaderHeight

Gets or sets the height of the page header in pixels. A negative value allows the page header to automatically size itself.

Declaration
public float PageHeaderHeight { get; set; }
Property Value
System.Single

PageHeaderIcon

Gets or sets the icon image displayed in the page header. This serves as the default icon when individual pages don't specify their own icon.

Declaration
public Image PageHeaderIcon { get; set; }
Property Value
System.Drawing.Image

PageHeaderIconAlignment

Gets or sets the alignment of the page header icon within its allocated space in the header area.

Declaration
public ContentAlignment PageHeaderIconAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

PageHeaderTextVisibility

Gets or sets the visibility of the page header text element that displays the page description.

Declaration
public ElementVisibility PageHeaderTextVisibility { get; set; }
Property Value
ElementVisibility

Pages

Gets the collection of wizard pages contained within this wizard element.

Declaration
public WizardPageCollection Pages { get; }
Property Value
WizardPageCollection

PageTitleTextVisibility

Gets or sets the visibility of the page title text element in the page header.

Declaration
public ElementVisibility PageTitleTextVisibility { get; set; }
Property Value
ElementVisibility

SelectedPage

Gets or sets the currently selected and visible wizard page. Setting this property triggers page change events and updates the wizard's UI.

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

View

Gets the current view implementation that handles the visual representation and layout for the wizard's current mode.

Declaration
public WizardView View { get; }
Property Value
WizardView

WelcomeImage

Gets or sets the background image displayed on welcome pages. This serves as the default image when individual welcome pages don't specify their own image.

Declaration
public Image WelcomeImage { get; set; }
Property Value
System.Drawing.Image

WelcomeImageBackgroundShape

Gets or sets the background image shape configuration for welcome pages, which controls advanced image rendering and styling options.

Declaration
public RadImageShape WelcomeImageBackgroundShape { get; set; }
Property Value
RadImageShape

WelcomeImageElement

Gets the visual element that displays the background image for welcome pages.

Declaration
public LightVisualElement WelcomeImageElement { get; }
Property Value
LightVisualElement

WelcomeImageLayout

Gets or sets the layout mode for the welcome page background image, determining how the image is positioned and scaled within its container.

Declaration
public ImageLayout WelcomeImageLayout { get; set; }
Property Value
System.Windows.Forms.ImageLayout

WelcomePage

Gets or sets the welcome page that typically appears as the first page in the wizard sequence.

Declaration
public WizardWelcomePage WelcomePage { get; set; }
Property Value
WizardWelcomePage

Methods

DisposeManagedResources()

Releases managed resources used by the wizard element, including event handler cleanup and base class disposal.

Declaration
protected override void DisposeManagedResources()
Overrides

HitTestButtons(Point)

Performs hit testing on the wizard's command buttons to determine if the specified point intersects with any button area.

Declaration
public bool HitTestButtons(Point controlClient)
Parameters
System.Drawing.Point controlClient

The point in control client coordinates to test for button intersection.
Returns
System.Boolean

True if the point intersects with any command button or view area; otherwise, false.

InitializeFields()

Initializes the fields and default values for the wizard element, including the page collection, default mode, and localization provider event handlers.

Declaration
protected override void InitializeFields()
Overrides

OnModeChanged(ModeChangedEventArgs)

Raises the ModeChanged event with the specified event arguments.

Declaration
protected virtual void OnModeChanged(ModeChangedEventArgs e)
Parameters
ModeChangedEventArgs e

The event arguments containing information about the completed mode change operation.

OnModeChanging(ModeChangingEventArgs)

Raises the ModeChanging event with the specified event arguments.

Declaration
protected virtual void OnModeChanging(ModeChangingEventArgs e)
Parameters
ModeChangingEventArgs e

The event arguments containing information about the mode change operation.

OnNext(WizardCancelEventArgs)

Raises the Next event with the specified event arguments.

Declaration
protected virtual void OnNext(WizardCancelEventArgs e)
Parameters
WizardCancelEventArgs e

The event arguments that can be used to cancel the next page navigation.

OnParentPropertyChanged(RadPropertyChangedEventArgs)

Handles parent property changes and ensures that the selected page's content area is properly parented to the control when the element tree changes.

Declaration
protected override void OnParentPropertyChanged(RadPropertyChangedEventArgs args)
Parameters
RadPropertyChangedEventArgs args

The property change event arguments containing information about the changed property.
Overrides

OnPrevious(WizardCancelEventArgs)

Raises the Previous event with the specified event arguments.

Declaration
protected virtual void OnPrevious(WizardCancelEventArgs e)
Parameters
WizardCancelEventArgs e

The event arguments that can be used to cancel the previous page navigation.

OnPropertyChanged(RadPropertyChangedEventArgs)

Handles property change notifications and applies special processing for the EnableAeroStyle property when the wizard is in Aero mode.

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

The property change event arguments containing information about the changed property.
Overrides

OnSelectedPageChanged(Object, SelectedPageChangedEventArgs)

Raises the SelectedPageChanged event with the specified event arguments.

Declaration
protected virtual void OnSelectedPageChanged(object sender, SelectedPageChangedEventArgs e)
Parameters
System.Object sender

The source of the event.
SelectedPageChangedEventArgs e

The event arguments containing information about the completed page change operation.

OnSelectedPageChanging(Object, SelectedPageChangingEventArgs)

Raises the SelectedPageChanging event with the specified event arguments.

Declaration
protected virtual void OnSelectedPageChanging(object sender, SelectedPageChangingEventArgs e)
Parameters
System.Object sender

The source of the event.
SelectedPageChangingEventArgs e

The event arguments containing information about the page change operation that can be canceled.

Refresh()

Refreshes the wizard element's visual representation by updating the view for the current page and invalidating the layout.

Declaration
public void Refresh()

SelectNextPage()

Navigates to the next wizard page in the sequence. Raises the Next event and can be canceled by the event handler.

Declaration
public void SelectNextPage()

SelectPreviousPage()

Navigates to the previous wizard page in the sequence. Raises the Previous event and can be canceled by the event handler.

Declaration
public void SelectPreviousPage()

Events

ModeChanged

Occurs after the wizard mode has been changed successfully.

Declaration
public event ModeChangedEventHandler ModeChanged
Event Type
ModeChangedEventHandler

ModeChanging

Occurs before the wizard mode is changed, allowing the operation to be canceled.

Declaration
public event ModeChangingEventHandler ModeChanging
Event Type
ModeChangingEventHandler

Next

Occurs when the Next button is clicked, allowing the navigation to be canceled.

Declaration
public event WizardCancelEventHandler Next
Event Type
WizardCancelEventHandler

Previous

Occurs when the Back button is clicked, allowing the navigation to be canceled.

Declaration
public event WizardCancelEventHandler Previous
Event Type
WizardCancelEventHandler

SelectedPageChanged

Occurs after the selected page has been changed successfully.

Declaration
public event SelectedPageChangedEventHandler SelectedPageChanged
Event Type
SelectedPageChangedEventHandler

SelectedPageChanging

Occurs before the selected page is changed, allowing the operation to be canceled.

Declaration
public event SelectedPageChangingEventHandler SelectedPageChanging
Event Type
SelectedPageChangingEventHandler

Extension Methods