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.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadWizardElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProviderInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadWizardElement...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadWizardElement class and sets up the event handlers for page collection changes.
public RadWizardElement()Fields
Identifies the EnableAeroStyle dependency property that controls whether Aero styling is applied when the wizard is in Aero mode.
public static RadProperty EnableAeroStylePropertyProperties
Gets the Back button element from the command area that allows navigation to the previous wizard page.
public RadButtonElement BackButton { get; }Gets the Cancel button element from the command area that allows the user to cancel the wizard operation.
public WizardCommandAreaButtonElement CancelButton { get; }Gets the command area element that contains the navigation buttons (Back, Next, Cancel, Finish, Help) for the wizard.
public WizardCommandArea CommandArea { get; }Gets or sets the height of the command area in pixels. A negative value allows the command area to automatically size itself.
public float CommandAreaHeight { get; set; }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.
public Image CompletionImage { get; set; }Gets or sets the background image shape configuration for completion pages, which controls advanced image rendering and styling options.
public RadImageShape CompletionImageBackgroundShape { get; set; }Gets the visual element that displays the background image for completion pages.
public LightVisualElement CompletionImageElement { get; }Gets or sets the layout mode for the completion page background image, determining how the image is positioned and scaled within its container.
public ImageLayout CompletionImageLayout { get; set; }Gets or sets the completion page that typically appears as the final page in the wizard sequence.
public WizardCompletionPage CompletionPage { get; set; }Gets or sets a value indicating whether the Aero visual style should be applied when the wizard is in Aero mode.
public bool EnableAeroStyle { get; set; }Gets the Finish button element from the command area that allows the user to complete the wizard operation.
public WizardCommandAreaButtonElement FinishButton { get; }Gets the Help button element from the command area that provides access to help information.
public LightVisualElement HelpButton { get; }Gets or sets a value indicating whether the completion page background image should be hidden from display.
public bool HideCompletionImage { get; set; }Gets or sets a value indicating whether the welcome page background image should be hidden from display.
public bool HideWelcomeImage { get; set; }Gets or sets the display mode of the wizard, which determines the visual style and behavior of the wizard interface.
public WizardMode Mode { get; set; }Gets the Next button element from the command area that allows navigation to the next wizard page.
public WizardCommandAreaButtonElement NextButton { get; }Gets the RadWizard control that owns this element instance.
public RadWizard OwnerControl { get; }Gets the page header element that displays the title, description, and icon for the current wizard page.
public WizardPageHeaderElement PageHeaderElement { get; }Gets or sets the height of the page header in pixels. A negative value allows the page header to automatically size itself.
public float PageHeaderHeight { get; set; }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.
public Image PageHeaderIcon { get; set; }Gets or sets the alignment of the page header icon within its allocated space in the header area.
public ContentAlignment PageHeaderIconAlignment { get; set; }Gets or sets the visibility of the page header text element that displays the page description.
public ElementVisibility PageHeaderTextVisibility { get; set; }Gets the collection of wizard pages contained within this wizard element.
public WizardPageCollection Pages { get; }Gets or sets the visibility of the page title text element in the page header.
public ElementVisibility PageTitleTextVisibility { get; set; }Gets or sets the currently selected and visible wizard page. Setting this property triggers page change events and updates the wizard's UI.
public WizardPage SelectedPage { get; set; }Gets the current view implementation that handles the visual representation and layout for the wizard's current mode.
public WizardView View { get; }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.
public Image WelcomeImage { get; set; }Gets or sets the background image shape configuration for welcome pages, which controls advanced image rendering and styling options.
public RadImageShape WelcomeImageBackgroundShape { get; set; }Gets the visual element that displays the background image for welcome pages.
public LightVisualElement WelcomeImageElement { get; }Gets or sets the layout mode for the welcome page background image, determining how the image is positioned and scaled within its container.
public ImageLayout WelcomeImageLayout { get; set; }Gets or sets the welcome page that typically appears as the first page in the wizard sequence.
public WizardWelcomePage WelcomePage { get; set; }Methods
Releases managed resources used by the wizard element, including event handler cleanup and base class disposal.
protected override void DisposeManagedResources()Overrides:
Performs hit testing on the wizard's command buttons to determine if the specified point intersects with any button area.
Initializes the fields and default values for the wizard element, including the page collection, default mode, and localization provider event handlers.
protected override void InitializeFields()Overrides:
Raises the ModeChanged event with the specified event arguments.
protected virtual void OnModeChanged(ModeChangedEventArgs e)The event arguments containing information about the completed mode change operation.
Raises the ModeChanging event with the specified event arguments.
protected virtual void OnModeChanging(ModeChangingEventArgs e)The event arguments containing information about the mode change operation.
Raises the Next event with the specified event arguments.
protected virtual void OnNext(WizardCancelEventArgs e)The event arguments that can be used to cancel the next page navigation.
Handles parent property changes and ensures that the selected page's content area is properly parented to the control when the element tree changes.
protected override void OnParentPropertyChanged(RadPropertyChangedEventArgs args)The property change event arguments containing information about the changed property.
Overrides:
Raises the Previous event with the specified event arguments.
protected virtual void OnPrevious(WizardCancelEventArgs e)The event arguments that can be used to cancel the previous page navigation.
Handles property change notifications and applies special processing for the EnableAeroStyle property when the wizard is in Aero mode.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)The property change event arguments containing information about the changed property.
Overrides:
Raises the SelectedPageChanged event with the specified event arguments.
protected virtual void OnSelectedPageChanged(object sender, SelectedPageChangedEventArgs e)The source of the event.
eSelectedPageChangedEventArgsThe event arguments containing information about the completed page change operation.
Raises the SelectedPageChanging event with the specified event arguments.
protected virtual void OnSelectedPageChanging(object sender, SelectedPageChangingEventArgs e)The source of the event.
eSelectedPageChangingEventArgsThe event arguments containing information about the page change operation that can be canceled.
Refreshes the wizard element's visual representation by updating the view for the current page and invalidating the layout.
public void Refresh()Navigates to the next wizard page in the sequence. Raises the Next event and can be canceled by the event handler.
public void SelectNextPage()Navigates to the previous wizard page in the sequence. Raises the Previous event and can be canceled by the event handler.
public void SelectPreviousPage()Events
Occurs after the wizard mode has been changed successfully.
public event ModeChangedEventHandler ModeChangedOccurs before the wizard mode is changed, allowing the operation to be canceled.
public event ModeChangingEventHandler ModeChangingOccurs when the Next button is clicked, allowing the navigation to be canceled.
public event WizardCancelEventHandler NextOccurs when the Back button is clicked, allowing the navigation to be canceled.
public event WizardCancelEventHandler PreviousOccurs after the selected page has been changed successfully.
public event SelectedPageChangedEventHandler SelectedPageChangedOccurs before the selected page is changed, allowing the operation to be canceled.
public event SelectedPageChangingEventHandler SelectedPageChanging