Class WizardControlPage
The WizardControlPage is used with the WizardControl.
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class WizardControlPage : WizardPage, IThemeProvider, IVisualStyle, IThemedControl, INonClientPaintingSupport, ISupportInitialize, IComponent, IDisposable
Constructors
WizardControlPage()
Declaration
public WizardControlPage()
WizardControlPage(IContainer)
Declaration
public WizardControlPage(IContainer container)
Parameters
Type | Name | Description |
---|---|---|
System.ComponentModel.IContainer | container |
Properties
BackEnabled
Gets or sets a value indicating whether the Back button is enabled.
Declaration
public bool BackEnabled { get; set; }
Property Value
Type |
---|
System.Boolean |
BackVisible
Gets or sets a value indicating whether the Back button is visible.
Declaration
public bool BackVisible { get; set; }
Property Value
Type |
---|
System.Boolean |
CancelEnabled
Gets or sets a value indicating whether the Cancel button is enabled.
Declaration
public bool CancelEnabled { get; set; }
Property Value
Type |
---|
System.Boolean |
CancelOverFinish
Gets or sets a value indicating whether the Cancel button is positioned over the Finish button.
Declaration
public bool CancelOverFinish { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
This will override the FinishVisible setting if true.
CancelVisible
Gets or sets a value indicating whether the Cancel button is visible.
Declaration
public bool CancelVisible { get; set; }
Property Value
Type |
---|
System.Boolean |
Description
Gets or sets the description of the page. Appears in the Description Label of the BannerPanel of the WizardControl.
Declaration
public string Description { get; set; }
Property Value
Type |
---|
System.String |
FinishEnabled
Gets or sets a value indicating whether the Finish button is enabled.
Declaration
public bool FinishEnabled { get; set; }
Property Value
Type |
---|
System.Boolean |
FinishVisible
Gets or sets a value indicating whether the Finish button is visible.
Declaration
public bool FinishVisible { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
This will be overridden by the CancelOverFinish property.
FullPage
Gets or sets a value indicating whether the BannerPanel of the WizardControl is hidden when this page is selected.
Declaration
public bool FullPage { get; set; }
Property Value
Type |
---|
System.Boolean |
HelpEnabled
Gets or sets a value indicating whether the Help button is enabled.
Declaration
public bool HelpEnabled { get; set; }
Property Value
Type |
---|
System.Boolean |
HelpVisible
Gets or sets a value indicating whether the Help button is visible.
Declaration
public bool HelpVisible { get; set; }
Property Value
Type |
---|
System.Boolean |
NextEnabled
Gets or sets a value indicating whether the Next button is enabled.
Declaration
public bool NextEnabled { get; set; }
Property Value
Type |
---|
System.Boolean |
NextVisible
Gets or sets a value indicating whether the Next button is visible.
Declaration
public bool NextVisible { get; set; }
Property Value
Type |
---|
System.Boolean |
Methods
OnPaint(PaintEventArgs)
Overides the Paint Event for drawing WizardControlPages.
Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Forms.PaintEventArgs | e | PaintEventArgs |
Overrides
RaiseBackClick()
Raises the BackClick event.
Declaration
public void RaiseBackClick()
RaiseCancelClick()
Raises the CancelClick event.
Declaration
public void RaiseCancelClick()
RaiseFinishClick()
Raises the FinishClick event.
Declaration
public void RaiseFinishClick()
RaiseHelpClick()
Raises the HelpClick event.
Declaration
public void RaiseHelpClick()
RaiseNextClick()
Raises the NextClick event.
Declaration
public void RaiseNextClick()
RaiseValidatePage(CancelEventArgs)
Raises the ValidatePage event.
Declaration
public void RaiseValidatePage(CancelEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.ComponentModel.CancelEventArgs | e | EventArgs that contains the event data. |
Events
BackClick
Occurs to notify that the back button was clicked.
Declaration
public event EventHandler BackClick
Event Type
Type |
---|
System.EventHandler |
CancelClick
Occurs to notify that the cancel button was clicked.
Declaration
public event EventHandler CancelClick
Event Type
Type |
---|
System.EventHandler |
FinishClick
Occurs to notify that the finish button was clicked.
Declaration
public event EventHandler FinishClick
Event Type
Type |
---|
System.EventHandler |
HelpClick
Occurs to notify that the help button was clicked.
Declaration
public event EventHandler HelpClick
Event Type
Type |
---|
System.EventHandler |
NextClick
Occurs to notify that the next button was clicked.
Declaration
public event EventHandler NextClick
Event Type
Type |
---|
System.EventHandler |
ValidatePage
Occurs to validate a page before a new page is selected.
Declaration
public event CancelEventHandler ValidatePage
Event Type
Type |
---|
System.ComponentModel.CancelEventHandler |
Remarks
You can validate this page and cancel new page selection, if necessary.