WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class WizardControl

    Show / Hide Table of Contents

    Class WizardControl

    The WizardControl is a control derived class that enables the creation of wizard applications. The manipulation of the WizardPages is easy through the designer verbs that are available to the user and it`s properties.

    Inheritance
    System.Object
    Wizard
    WizardControl
    Implements
    System.ComponentModel.ISupportInitialize
    IThemeProvider
    IVisualStyle
    Inherited Members
    Wizard.wizardPgs
    Wizard.OnAfterPageSelect(WizardPageSelectEventArgs)
    Wizard.OnBeforePageSelect(WizardPageSelectEventArgs)
    Wizard.OnNext(EventArgs)
    Wizard.OnBack(EventArgs)
    Wizard.SetPageContainer(WizardContainer)
    Wizard.EndInit()
    Wizard.InitDesignerHostRef()
    Wizard.AddPage(WizardPage)
    Wizard.PageSettingsChanged(Object, EventArgs)
    Wizard.PageSettingsChanged()
    Wizard.RemovePage()
    Wizard.RemovePage(WizardPage)
    Wizard.NextPage()
    Wizard.PreviousPage()
    Wizard.GetIsMirrored()
    Wizard.PageContainer
    Wizard.DesignerHost
    Wizard.CardLayout
    Wizard.Next
    Wizard.Back
    Wizard.BeforePageSelect
    Wizard.AfterPageSelect
    Namespace: Syncfusion.Windows.Forms.Tools
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public class WizardControl : Wizard, ISupportInitialize, IThemeProvider, IVisualStyle

    Constructors

    WizardControl()

    Creates a new instance of the WizardControl class.

    Declaration
    public WizardControl()

    Properties

    AutoLayoutBanner

    Gets or sets a value indicating whether auto layout banner in banner control.

    Declaration
    public bool AutoLayoutBanner { get; set; }
    Property Value
    Type Description
    System.Boolean

    AutoLayoutDescription

    Gets or sets a value indicating whether auto layout title in description control.

    Declaration
    public bool AutoLayoutDescription { get; set; }
    Property Value
    Type Description
    System.Boolean

    AutoLayoutTitle

    Gets or sets a value indicating whether auto layout title in banner control.

    Declaration
    public bool AutoLayoutTitle { get; set; }
    Property Value
    Type Description
    System.Boolean

    BackButton

    Gets the Back button of the WizardControl.

    Declaration
    public ButtonAdv BackButton { get; }
    Property Value
    Type Description
    ButtonAdv

    BackButtonCausesValidation

    Gets or sets a value indicating whether the ValidatePage event being fired.

    Declaration
    public bool BackButtonCausesValidation { get; set; }
    Property Value
    Type Description
    System.Boolean

    Banner

    Gets or sets the PictureBox that shows the Banner Image of the Wizard.

    Declaration
    public PictureBox Banner { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.PictureBox

    BannerPanel

    Gets or sets the Banner Panel of the WizardControl.

    Declaration
    public GradientPanel BannerPanel { get; set; }
    Property Value
    Type Description
    GradientPanel

    CanApplyTheme

    Gets or sets a value indicating whether a SkinManager theme style has been applied to the control.

    Declaration
    public bool CanApplyTheme { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is true.

    CancelButton

    Gets the Cancel button of the WizardControl.

    Declaration
    public ButtonAdv CancelButton { get; }
    Property Value
    Type Description
    ButtonAdv

    CanOverrideStyle

    Gets or sets a value indicating whether control elements styles can be overridden by theme style settings.

    Declaration
    public bool CanOverrideStyle { get; set; }
    Property Value
    Type Description
    System.Boolean

    Default value is false.

    Remarks

    By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. This property should be enabled or disabled before calling the ThemeName property of the control.

    ControlName

    Gets the name of the control.

    Declaration
    public string ControlName { get; }
    Property Value
    Type Description
    System.String

    Description

    Gets or sets the label that shows the description of the current page.

    Declaration
    public Label Description { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Label
    Remarks

    The specified Label, if not a child of the BannerPanel will then be made a child of the BannerPanel.

    FinishButton

    Gets the Finish button of the WizardControl.

    Declaration
    public ButtonAdv FinishButton { get; }
    Property Value
    Type Description
    ButtonAdv

    GridBagLayout

    Gets the GridBagLayout used to layout the different controls in the WizardControl.

    Declaration
    public GridBagLayout GridBagLayout { get; }
    Property Value
    Type Description
    GridBagLayout

    HelpButton

    Gets the Help button of the WizardControl.

    Declaration
    public ButtonAdv HelpButton { get; }
    Property Value
    Type Description
    ButtonAdv

    IsVisualStyleEnabled

    Gets a value indicating whether the visual style based theme is applied to the control. This also indicates whether the theme files are referred from external assemblies or not.

    Declaration
    public bool IsVisualStyleEnabled { get; }
    Property Value
    Type Description
    System.Boolean

    Return true, if the visual style based theme is applied to control. Otherwise returns false.

    NextButton

    Gets the Next button of the WizardControl.

    Declaration
    public ButtonAdv NextButton { get; }
    Property Value
    Type Description
    ButtonAdv

    SelectedPage

    Declaration
    public override WizardPage SelectedPage { get; set; }
    Property Value
    Type Description
    WizardPage
    Overrides
    Wizard.SelectedPage

    SelectedWizardPage

    Gets or sets the selected wizard control page.

    Declaration
    public WizardControlPage SelectedWizardPage { get; set; }
    Property Value
    Type Description
    WizardControlPage

    Style

    Declaration
    public Theme Style { get; set; }
    Property Value
    Type Description
    Theme

    ThemeName

    Gets or sets the theme name of the WizardControl control.

    Declaration
    public string ThemeName { get; set; }
    Property Value
    Type Description
    System.String

    ThemeStyle

    Gets or sets the WizardControlVisualStyle value used to customize the appearance of the WizardControl.

    Declaration
    public WizardControlVisualStyle ThemeStyle { get; set; }
    Property Value
    Type Description
    WizardControlVisualStyle
    Remarks

    This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

    Title

    Gets or sets the label that shows the title of the current page.

    Declaration
    public Label Title { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Label
    Remarks

    The specified Label, if not a child of the BannerPanel will then be made a child of the BannerPanel.

    WizardPageContainer

    Gets or sets the PageContainer of the WizardControl.

    Declaration
    public WizardContainer WizardPageContainer { get; set; }
    Property Value
    Type Description
    WizardContainer

    WizardPages

    Gets or sets the array that holds the pages.

    Declaration
    public WizardControlPage[] WizardPages { get; set; }
    Property Value
    Type Description
    WizardControlPage[]

    Methods

    Dispose(Boolean)

    Cleans up any resources being used.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    Bool disposing

    Overrides
    Wizard.Dispose(Boolean)

    GetActiveThemeName()

    Gets the active theme name of the control.

    Declaration
    public virtual string GetActiveThemeName()
    Returns
    Type Description
    System.String

    Returns the active theme name.

    GetControlName(String)

    Help to override the ThemeName property settings.

    Declaration
    public virtual string GetControlName(string controlName)
    Parameters
    Type Name Description
    System.String controlName

    name of the control

    Returns
    Type Description
    System.String

    OnBannerControlLocationChanging(Control, CancelEventArgs)

    Raises the BannerControlLocationChanging event

    Declaration
    protected virtual void OnBannerControlLocationChanging(Control banerControl, CancelEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.Control banerControl

    Banner control

    System.ComponentModel.CancelEventArgs e

    EventArgs that contains the event data.

    OnBeforeBack(CancelEventArgs)

    Raises the BeforeBack event.

    Declaration
    protected virtual void OnBeforeBack(CancelEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CancelEventArgs e

    A CancelEventArgs that lets you cancel the action.

    Remarks

    Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

    The OnBeforeBack method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnBeforeBack in a derived class, be sure to call the base class's OnBeforeBack method so that registered delegates receive the event.

    OnBeforeFinish(CancelEventArgs)

    Raises the BeforeFinish event.

    Declaration
    protected virtual void OnBeforeFinish(CancelEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CancelEventArgs e

    A CancelEventArgs that lets you cancel the action.

    Remarks

    Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

    The OnBeforeFinish method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnBeforeFinish in a derived class, be sure to call the base class's OnBeforeFinish method so that registered delegates receive the event.

    OnBeforeNext(CancelEventArgs)

    Raises the BeforeNext event.

    Declaration
    protected virtual void OnBeforeNext(CancelEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CancelEventArgs e

    A CancelEventArgs that lets you cancel the action.

    Remarks

    Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

    The OnBeforeNext method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnBeforeNext in a derived class, be sure to call the base class's OnBeforeNext method so that registered delegates receive the event.

    OnCancel(EventArgs)

    Raises the Cancel event

    Declaration
    protected void OnCancel(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnEnabledChanged(EventArgs)

    Override the System.Windows.Forms.Control.EnabledChanged event for WizardControl.

    Declaration
    protected override void OnEnabledChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    An System.EventArgs that contains the event data.

    OnEndInit()

    Initializes the dynamic controls used in the wizard.

    Declaration
    protected override void OnEndInit()
    Overrides
    Wizard.OnEndInit()

    OnFinish(EventArgs)

    Raises the Finish event

    Declaration
    protected void OnFinish(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnHelp(EventArgs)

    Raises the Help event

    Declaration
    protected void OnHelp(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    EventArgs that contains the event data.

    OnLoad(EventArgs)

    Declaration
    protected override void OnLoad(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnPaint(PaintEventArgs)

    Overides the Paint Event for drawing Wizardcontrol.

    Declaration
    protected override void OnPaint(PaintEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    PaintEventArgs

    OnRightToLeftChanged(EventArgs)

    Declaration
    protected override void OnRightToLeftChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnSizeChanged(EventArgs)

    Declaration
    protected override void OnSizeChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    RaiseThemeChanged(Object, ThemeChangedEventArgs)

    Raises the event when themename changed.

    Declaration
    protected virtual void RaiseThemeChanged(object sender, ThemeChangedEventArgs args)
    Parameters
    Type Name Description
    System.Object sender

    The sender value.

    ThemeChangedEventArgs args

    A ThemeChangedEventArgs contains the event data.

    RefreshAppearance()

    Declaration
    protected override void RefreshAppearance()
    Overrides
    Wizard.RefreshAppearance()

    RepositionBannerControls()

    Declaration
    protected void RepositionBannerControls()

    RepositionBannerControls(Boolean)

    Declaration
    protected void RepositionBannerControls(bool bIsMirrored)
    Parameters
    Type Name Description
    System.Boolean bIsMirrored

    RepositionNavigationButtons(Boolean)

    Positions the Navigation buttons.

    Declaration
    protected void RepositionNavigationButtons(bool bIsMirrored)
    Parameters
    Type Name Description
    System.Boolean bIsMirrored

    bool Mirrored

    SetPageContainerConstraints()

    Declaration
    protected void SetPageContainerConstraints()

    Events

    BannerControlLocationChanging

    Occurs when Banner Panel controls are laid out.

    Declaration
    public event CancelEventHandler BannerControlLocationChanging
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler

    BeforeBack

    Occurs before the Back button is clicked.

    Declaration
    public event CancelEventHandler BeforeBack
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler
    Remarks

    You can validate the current SelectedPage and cancel the back button click, if necessary.

    BeforeCancel

    Occurs before the Cancel button is clicked.

    Declaration
    public event CancelEventHandler BeforeCancel
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler
    Remarks

    You can cancel the cancel button click if necessary.

    BeforeFinish

    Occurs before the Finish button is clicked.

    Declaration
    public event CancelEventHandler BeforeFinish
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler
    Remarks

    You can validate the current SelectedPage and cancel the finish button click, if necessary.

    BeforeNext

    Occurs before the Next button is clicked.

    Declaration
    public event CancelEventHandler BeforeNext
    Event Type
    Type Description
    System.ComponentModel.CancelEventHandler
    Remarks

    You can validate the current SelectedPage and cancel the next button click, if necessary.

    Cancel

    Occurs before Cancel button is clicked

    Declaration
    public event EventHandler Cancel
    Event Type
    Type Description
    System.EventHandler

    Finish

    Occurs before Finish button is clicked

    Declaration
    public event EventHandler Finish
    Event Type
    Type Description
    System.EventHandler

    Help

    Occurs before Help button is clicked

    Declaration
    public event EventHandler Help
    Event Type
    Type Description
    System.EventHandler

    ThemeNameChanged

    Occurs when theme name of the has changed.

    Declaration
    public event ThemeChangedEventHandler ThemeNameChanged
    Event Type
    Type Description
    ThemeChangedEventHandler

    Explicit Interface Implementations

    IVisualStyle.VisualTheme

    Gets or sets the VisualTheme.

    Declaration
    string IVisualStyle.VisualTheme { get; set; }
    Returns
    Type Description
    System.String

    IThemeProvider.BaseThemeName

    Gets or sets the Base Theme name of the theme

    Declaration
    string IThemeProvider.BaseThemeName { get; set; }
    Returns
    Type Description
    System.String

    Implements

    System.ComponentModel.ISupportInitialize
    IThemeProvider
    IVisualStyle
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved