Documentation

Class RadWizardElement

Encapsulates the UI representation and functionality of RadWizard.

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, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadWizardElement()

Creates a RadWizardElement instance.

Declaration
public RadWizardElement()

Fields

EnableAeroStyleProperty

Declaration
public static RadProperty EnableAeroStyleProperty
Field Value
RadProperty

Properties

BackButton

Gets the command area's back button.

Declaration
public RadButtonElement BackButton { get; }
Property Value
RadButtonElement

CancelButton

Gets the command area's cancel button.

Declaration
public WizardCommandAreaButtonElement CancelButton { get; }
Property Value
WizardCommandAreaButtonElement

CommandArea

Gets the command area element.

Declaration
public WizardCommandArea CommandArea { get; }
Property Value
WizardCommandArea

CommandAreaHeight

Gets or sets the height of the command area. Negative value makes the command area autosize.

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

CompletionImage

Gets or sets the image of the completion pages.

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

CompletionImageBackgroundShape

Gets or sets the background image shape of the completion pages.

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

CompletionImageElement

Gets the element containing the image of the completion pages.

Declaration
public LightVisualElement CompletionImageElement { get; }
Property Value
LightVisualElement

CompletionImageLayout

Gets or sets the layout of the completion pages image.

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

CompletionPage

Gets or sets the completion page.

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

EnableAeroStyle

Gets or sets a value indication wether the Aero style should apply when RadWizard is in Wizard Aero mode.

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

FinishButton

Gets the command area's finish button.

Declaration
public WizardCommandAreaButtonElement FinishButton { get; }
Property Value
WizardCommandAreaButtonElement

HelpButton

Gets the command area's help button.

Declaration
public LightVisualElement HelpButton { get; }
Property Value
LightVisualElement

HideCompletionImage

Gets or sets a value indicating whether the image of the completion pages should be visible.

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

HideWelcomeImage

Gets or sets a value indicating whether the image of the welcome pages should be visible.

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

Mode

Gets or sets the mode of RadWizard.

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

NextButton

Gets the command area's next button.

Declaration
public WizardCommandAreaButtonElement NextButton { get; }
Property Value
WizardCommandAreaButtonElement

OwnerControl

Gets the Owner RadWizard control.

Declaration
public RadWizard OwnerControl { get; }
Property Value
RadWizard

PageHeaderElement

Gets the page header element.

Declaration
public WizardPageHeaderElement PageHeaderElement { get; }
Property Value
WizardPageHeaderElement

PageHeaderHeight

Gets or sets the height of the page header. Negative value makes the page header autosize.

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

PageHeaderIcon

Gets or sets the icon of the page header.

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

PageHeaderIconAlignment

Gets or sets the alignment of the page header's icon.

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

PageHeaderTextVisibility

Gets or sets the visibility of the page header's header element.

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

Pages

Gets the pages collection.

Declaration
public WizardPageCollection Pages { get; }
Property Value
WizardPageCollection

PageTitleTextVisibility

Gets or sets the visibility of the page header's title element.

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

SelectedPage

Gets or sets the selected page.

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

View

Gets the view of RadWizard.

Declaration
public WizardView View { get; }
Property Value
WizardView

WelcomeImage

Gets or sets the image of the welcome pages.

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

WelcomeImageBackgroundShape

Gets or sets the background image shape of the welcome pages.

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

WelcomeImageElement

Gets the element containing the image of the welcome pages.

Declaration
public LightVisualElement WelcomeImageElement { get; }
Property Value
LightVisualElement

WelcomeImageLayout

Gets or sets the layout of the welcome pages image.

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

WelcomePage

Gets or sets the welcome page.

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

Methods

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

HitTestButtons(Point)

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

Returns
System.Boolean

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

OnModeChanged(ModeChangedEventArgs)

Raises the ModeChanged event.

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

An instance of ModeChangedEventArgs containing event data.

OnModeChanging(ModeChangingEventArgs)

Raises the ModeChanging event.

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

An instance of ModeChangingEventArgs containing event data.

OnNext(WizardCancelEventArgs)

Raises the Next event.

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

An instance of WizardCancelEventArgs containing event data.

OnParentPropertyChanged(RadPropertyChangedEventArgs)

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

Overrides

OnPrevious(WizardCancelEventArgs)

Raises the Previous event.

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

An instance of WizardCancelEventArgs containing event data.

OnPropertyChanged(RadPropertyChangedEventArgs)

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

Overrides

OnSelectedPageChanged(Object, SelectedPageChangedEventArgs)

Raises the SelectedPageChanged event.

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

The owner.
SelectedPageChangedEventArgs e

An instance of SelectedPageChangedEventArgs containing event data.

OnSelectedPageChanging(Object, SelectedPageChangingEventArgs)

Raises the SelectedPageChanging event.

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

The owner.
SelectedPageChangingEventArgs e

An instance of SelectedPageChangingEventArgs containing event data.

Refresh()

Refreshes the element's view.

Declaration
public void Refresh()

SelectNextPage()

Selects next wizard page.

Declaration
public void SelectNextPage()

SelectPreviousPage()

Selects previous wizard page.

Declaration
public void SelectPreviousPage()

Events

ModeChanged

Fires after the mode of RadWizard is changed.

Declaration
public event ModeChangedEventHandler ModeChanged
Event Type
ModeChangedEventHandler

ModeChanging

Fires before the mode of RadWizard is changed.

Declaration
public event ModeChangingEventHandler ModeChanging
Event Type
ModeChangingEventHandler

Next

Fires when the next command button is clicked.

Declaration
public event WizardCancelEventHandler Next
Event Type
WizardCancelEventHandler

Previous

Fires when the back command button is clicked.

Declaration
public event WizardCancelEventHandler Previous
Event Type
WizardCancelEventHandler

SelectedPageChanged

Fires after the selected page of RadWizard is changed.

Declaration
public event SelectedPageChangedEventHandler SelectedPageChanged
Event Type
SelectedPageChangedEventHandler

SelectedPageChanging

Fires before the selected page of RadWizard is changed.

Declaration
public event SelectedPageChangingEventHandler SelectedPageChanging
Event Type
SelectedPageChangingEventHandler

Extension Methods