Class

RadWizardElement

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

Declaration

public RadWizardElement()

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

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

Declaration

public RadButtonElement BackButton { get; }

Property Value

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

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

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

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

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

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

Declaration

public LightVisualElement CompletionImageElement { get; }

Property Value

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

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

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

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

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

Declaration

public LightVisualElement HelpButton { get; }

Property Value

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

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

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

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

Declaration

public WizardCommandAreaButtonElement NextButton { get; }

Property Value

Gets the RadWizard control that owns this element instance.

Declaration

public RadWizard OwnerControl { get; }

Property Value

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

Declaration

public WizardPageHeaderElement PageHeaderElement { get; }

Property Value

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

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

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

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

Declaration

public ElementVisibility PageHeaderTextVisibility { get; set; }

Property Value

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

Declaration

public ElementVisibility PageTitleTextVisibility { get; set; }

Property Value

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

Declaration

public WizardPageCollection Pages { get; }

Property Value

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

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

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

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

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

Declaration

public LightVisualElement WelcomeImageElement { get; }

Property Value

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

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

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

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

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

Returns

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 LightVisualElement.InitializeFields()

Raises the ModeChanged event with the specified event arguments.

Declaration

protected virtual void OnModeChanged(ModeChangedEventArgs e)

Parameters

Raises the ModeChanging event with the specified event arguments.

Declaration

protected virtual void OnModeChanging(ModeChangingEventArgs e)

Parameters

Raises the Next event with the specified event arguments.

Declaration

protected virtual void OnNext(WizardCancelEventArgs e)

Parameters

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

Overrides RadElement.OnParentPropertyChanged(RadPropertyChangedEventArgs)

Raises the Previous event with the specified event arguments.

Declaration

protected virtual void OnPrevious(WizardCancelEventArgs e)

Parameters

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

Overrides LightVisualElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the SelectedPageChanged event with the specified event arguments.

Declaration

protected virtual void OnSelectedPageChanged(object sender, SelectedPageChangedEventArgs e)

Parameters

Raises the SelectedPageChanging event with the specified event arguments.

Declaration

protected virtual void OnSelectedPageChanging(object sender, SelectedPageChangingEventArgs e)

Parameters

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

Declaration

public void Refresh()

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()

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()

Occurs after the wizard mode has been changed successfully.

Declaration

public event ModeChangedEventHandler ModeChanged

Event Value

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

Declaration

public event ModeChangingEventHandler ModeChanging

Event Value

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

Declaration

public event WizardCancelEventHandler Next

Event Value

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

Declaration

public event WizardCancelEventHandler Previous

Event Value

Occurs after the selected page has been changed successfully.

Declaration

public event SelectedPageChangedEventHandler SelectedPageChanged

Event Value

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

Declaration

public event SelectedPageChangingEventHandler SelectedPageChanging

Event Value