WizardPage Class
Represents a page within a Wizard control.
public class WizardPage : UIContainerControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable
- Inheritance:
- Object UIContainerControl Object
- Derived:
- WizardWelcomePage
- Implements:
- IUIControl IUIElement ILogicalTreeNode IDpiAwareElement System.IDisposable
Remarks
This class is used to track information relating to each page in a Wizard control.
Constructors
WizardPage()
Initializes a new instance of the WizardPage
class.
public WizardPage()
Properties
Anchor
Gets or sets which edges of the control are anchored to the edges of its container.
public override AnchorStyles Anchor { get; set; }
Property Value
- AnchorStyles:
A bitwise combination of the AnchorStyles values. The default is
Top
andLeft
.
BackButtonEnabled
Determines the enabled state of the Back button when this page is selected.
public WizardButtonEnabledDefault BackButtonEnabled { get; set; }
Property Value
- WizardButtonEnabledDefault:
A WizardButtonEnabledDefault specifying the enabled state of the button.
Remarks
This property should only be set at design-time.
See Also
BackButtonVisible
Determines the visibility of the Back button when this page is selected.
public bool BackButtonVisible { get; set; }
Property Value
- Boolean:
true
if the button should be visible; otherwise,false
.
Remarks
This property should only be set at design-time.
BackgroundFill
Gets or sets the page-specific BackgroundFill for the page.
public BackgroundFill BackgroundFill { get; set; }
Property Value
- BackgroundFill:
The page-specific BackgroundFill for the page.
ButtonContainerBackgroundFill
Gets or sets the page-specific BackgroundFill for the button container.
public BackgroundFill ButtonContainerBackgroundFill { get; set; }
Property Value
- BackgroundFill:
The page-specific BackgroundFill for the button container.
CancelButtonEnabled
Determines the enabled state of the Cancel button when this page is selected.
public WizardButtonEnabledDefault CancelButtonEnabled { get; set; }
Property Value
- WizardButtonEnabledDefault:
A WizardButtonEnabledDefault specifying the enabled state of the button.
Remarks
This property should only be set at design-time.
See Also
CancelButtonVisible
Determines the visibility of the Cancel button when this page is selected.
public bool CancelButtonVisible { get; set; }
Property Value
- Boolean:
true
if the button should be visible; otherwise,false
.
Remarks
This property should only be set at design-time.
CausesValidation
Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus.
public bool CausesValidation { get; set; }
Property Value
- Boolean:
true
if the control causes validation to be performed on any controls requiring validation when it receives focus; otherwise,false
. The default istrue
.
Dock
Gets or sets which edge of the parent container a control is docked to.
public override DockStyle Dock { get; set; }
Property Value
FinishButtonEnabled
Determines the enabled state of the Finish button when this page is selected.
public WizardButtonEnabledDefault FinishButtonEnabled { get; set; }
Property Value
- WizardButtonEnabledDefault:
A WizardButtonEnabledDefault specifying the enabled state of the button.
Remarks
This property should only be set at design-time.
This property also controls the enabled state of the Finish button, since the Finish button is simply the Finish button with a different caption.
See Also
FinishButtonVisible
Determines the visibility of the Finish button when this page is selected.
public bool FinishButtonVisible { get; set; }
Property Value
- Boolean:
true
if the button should be visible; otherwise,false
.
Remarks
This property should only be set at design-time.
HelpButtonEnabled
Determines the enabled state of the Help button when this page is selected.
public WizardButtonEnabledDefault HelpButtonEnabled { get; set; }
Property Value
- WizardButtonEnabledDefault:
A WizardButtonEnabledDefault specifying the enabled state of the button.
Remarks
This property should only be set at design-time.
See Also
HelpButtonVisible
Determines the visibility of the Help button when this page is selected.
public bool HelpButtonVisible { get; set; }
Property Value
- Boolean:
true
if the button should be visible; otherwise,false
.
Remarks
This property should only be set at design-time.
InteriorPageHeaderBackgroundFill
Gets or sets the page-specific BackgroundFill for the header of the page if it is an interior page.
public BackgroundFill InteriorPageHeaderBackgroundFill { get; set; }
Property Value
- BackgroundFill:
The page-specific BackgroundFill for the header of the page if it is an interior page.
InteriorPageHeaderImage
Gets or sets the page-specific System.Drawing.Image for the header of the page if it is an interior page.
public Image InteriorPageHeaderImage { get; set; }
Property Value
- System.Drawing.Image:
The page-specific System.Drawing.Image for the header of the page if it is an interior page.
IsInteriorPage
Gets or sets whether the page is an interior page.
public bool IsInteriorPage { get; set; }
Property Value
- Boolean:
true
if the page is an interior page; otherwise,false
.
Remarks
Interior pages make use of the header and are padded from the sides of the Wizard.
Exterior pages fill the entire Wizard client area.
Location
Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
public Point Location { get; set; }
Property Value
NextButtonEnabled
Determines the enabled state of the Next button when this page is selected.
public WizardButtonEnabledDefault NextButtonEnabled { get; set; }
Property Value
- WizardButtonEnabledDefault:
A WizardButtonEnabledDefault specifying the enabled state of the button.
Remarks
This property should only be set at design-time.
This property also controls the enabled state of the Finish button, since the Finish button is simply the Next button with a different caption.
See Also
NextButtonVisible
Determines the visibility of the Next button when this page is selected.
public bool NextButtonVisible { get; set; }
Property Value
- Boolean:
true
if the button should be visible; otherwise,false
.
Remarks
This property should only be set at design-time.
PageCaption
Gets or sets the caption of the page.
public virtual string PageCaption { get; set; }
Property Value
PageDescription
Gets or sets the description of the page.
public virtual string PageDescription { get; set; }
Property Value
PageTitleBarText
Gets or sets the title bar text of the page.
public virtual string PageTitleBarText { get; set; }
Property Value
- String:
The title bar text displayed on a WizardDialogForm for the page.
Size
Gets or sets the height and width of the control.
public Size Size { get; set; }
Property Value
UseExtendedDoubleBuffering
Gets or sets whether to use extended double buffering for rendering.
protected override bool UseExtendedDoubleBuffering { get; }
Property Value
- Boolean:
true
if extended double buffering should be used; otherwise,false
.
Visible
Gets or sets a value indicating whether the control is displayed.
public bool Visible { get; set; }
Property Value
- Boolean:
true
if the control is displayed; otherwise,false
. The default istrue
.
Wizard
Gets the Wizard that contains the page.
Methods
CreateControlsInstance()
Creates a new instance of the control collection for the control.
protected override Control.ControlCollection CreateControlsInstance()
Returns
- Control.ControlCollection:
A new instance of a Control.ControlCollection assigned to the control.
Dispose(Boolean)
Clean up any resources being used.
protected override void Dispose(bool disposing)
Parameter | Type | Description |
---|---|---|
disposing | Boolean |
OnBackButtonClick(WizardPageCancelEventArgs)
Raises the BackButtonClick
event.
protected virtual void OnBackButtonClick(WizardPageCancelEventArgs e)
Parameter | Type | Description |
---|---|---|
e | WizardPageCancelEventArgs | A WizardPageCancelEventArgs that contains the event data. |
OnCancelButtonClick(EventArgs)
Raises the CancelButtonClick
event.
protected virtual void OnCancelButtonClick(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An EventArgs that contains the event data. |
OnCreateControl()
Raises the CreateControl
event.
protected override void OnCreateControl()
OnFinishButtonClick(EventArgs)
Raises the FinishButtonClick
event.
protected virtual void OnFinishButtonClick(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An EventArgs that contains the event data. |
OnHelpButtonClick(EventArgs)
Raises the HelpButtonClick
event.
protected virtual void OnHelpButtonClick(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An EventArgs that contains the event data. |
OnLoad(EventArgs)
Raises the Load
event.
protected virtual void OnLoad(EventArgs e)
Parameter | Type | Description |
---|---|---|
e | EventArgs | An EventArgs that contains the event data. |
OnMouseDown(MouseEventArgs)
Raises the MouseDown
event.
protected override void OnMouseDown(MouseEventArgs e)
Parameter | Type | Description |
---|---|---|
e | MouseEventArgs | A MouseEventArgs that contains the event data. |
OnNextButtonClick(WizardPageCancelEventArgs)
Raises the NextButtonClick
event.
protected virtual void OnNextButtonClick(WizardPageCancelEventArgs e)
Parameter | Type | Description |
---|---|---|
e | WizardPageCancelEventArgs | A WizardPageCancelEventArgs that contains the event data. |
OnRender(PaintEventArgs)
Renders the element.
protected override void OnRender(PaintEventArgs e)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
ProcessTabKey(Boolean)
Selects the next available control and makes it the active control.
protected override bool ProcessTabKey(bool forward)
Parameter | Type | Description |
---|---|---|
forward | Boolean |
|
Returns
- Boolean:
true
if a control is selected; otherwise,false
.
ResetBackgroundFill()
Resets the BackgroundFill property to its default value.
public virtual void ResetBackgroundFill()
ResetButtonContainerBackgroundFill()
Resets the ButtonContainerBackgroundFill property to its default value.
public virtual void ResetButtonContainerBackgroundFill()
ResetInteriorPageHeaderBackgroundFill()
Resets the InteriorPageHeaderBackgroundFill property to its default value.
public virtual void ResetInteriorPageHeaderBackgroundFill()
ResetInteriorPageHeaderImage()
Resets the InteriorPageHeaderImage property to its default value.
public virtual void ResetInteriorPageHeaderImage()
ShouldSerializeBackgroundFill()
Indicates whether the BackgroundFill property should be persisted.
public virtual bool ShouldSerializeBackgroundFill()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeButtonContainerBackgroundFill()
Indicates whether the ButtonContainerBackgroundFill property should be persisted.
public virtual bool ShouldSerializeButtonContainerBackgroundFill()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeInteriorPageHeaderBackgroundFill()
Indicates whether the InteriorPageHeaderBackgroundFill property should be persisted.
public virtual bool ShouldSerializeInteriorPageHeaderBackgroundFill()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeInteriorPageHeaderImage()
Indicates whether the InteriorPageHeaderImage property should be persisted.
public virtual bool ShouldSerializeInteriorPageHeaderImage()
Returns
- Boolean:
true
if the property value has changed from its default; otherwise,false
.
ToString()
Returns a String
that represents the current Object
.
WndProc(ref Message)
Processes Windows messages.
protected override void WndProc(ref Message m)
Parameter | Type | Description |
---|---|---|
m | Message | The Windows Message to process. |
Events
BackButtonClick
Occurs when this page is selected and the Back button is clicked.
public event WizardPageCancelEventHandler BackButtonClick
Event Type
Remarks
By default, the Wizard will move to the previous WizardPage in the
WizardPageCollection after this event fires. To cancel this behavior, set
the Cancel
property of the event argument to true
. Then you can use
the SelectedPage property to set the WizardPage that should
be displayed.
If an event handler is set for this event on this page, and the event is raised, it will only be raised from this WizardPage. The more general associated event on the Wizard will not be raised.
CancelButtonClick
Occurs when this page is selected and the Cancel button is clicked.
public event EventHandler CancelButtonClick
Event Type
Remarks
Handlers of this event generally abort any currently-executing processing tasks and
close the Form
containing the Wizard control.
If an event handler is set for this event on this page, and the event is raised, it will only be raised from this WizardPage. The more general associated event on the Wizard will not be raised.
FinishButtonClick
Occurs when this page is selected and the Finish button is clicked.
public event EventHandler FinishButtonClick
Event Type
Remarks
Handlers of this event generally finish processing any remaining wizard tasks.
If an event handler is set for this event on this page, and the event is raised, it will only be raised from this WizardPage. The more general associated event on the Wizard will not be raised.
HelpButtonClick
Occurs when this page is selected and the Help button is clicked.
public event EventHandler HelpButtonClick
Event Type
Remarks
Handlers of this event generally display help for the currently displayed wizard step.
If an event handler is set for this event on this page, and the event is raised, it will only be raised from this WizardPage. The more general associated event on the Wizard will not be raised.
Load
Occurs before the control becomes visible for the first time.
public event EventHandler Load
Event Type
Remarks
You can use this event to perform tasks such as allocating resources used by the control.
NextButtonClick
Occurs when this page is selected and the Next button is clicked.
public event WizardPageCancelEventHandler NextButtonClick
Event Type
Remarks
By default, the Wizard will move to the next WizardPage in the
WizardPageCollection after this event fires. To cancel this behavior, set
the Cancel
property of the event argument to true
. Then you can use
the SelectedPage property to set the WizardPage that should
be displayed.
If an event handler is set for this event on this page, and the event is raised, it will only be raised from this WizardPage. The more general associated event on the Wizard will not be raised.
Inherited Members
- UIContainerControl.ILogicalTreeNode.FindAncestor(Type)
- UIContainerControl.ILogicalTreeNode.GetCommonAncestor(ILogicalTreeNode)
- UIContainerControl.ILogicalTreeNode.IsAncestorOf(ILogicalTreeNode)
- UIContainerControl.ILogicalTreeNode.IsDescendantOf(ILogicalTreeNode)
- UIContainerControl.IUIControl.AddPendingGraphicsInversion(Rectangle)
- UIContainerControl.IUIControl.AddPendingScrollOperation(Rectangle, Orientation, Int32)
- UIContainerControl.IUIControl.AddPendingScrollOperation(Rectangle, Int32, Int32)
- UIContainerControl.IUIControl.AddToInvalidatedRegion(Rectangle)
- UIContainerControl.IUIElement.GetDrawState()
- UIContainerControl.IUIElement.HitTest(PointHitTestParameters)
- UIContainerControl.IUIElement.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIContainerControl.IUIElement.HitTestRecursive(PointHitTestParameters)
- UIContainerControl.IUIElement.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIContainerControl.IUIElement.NotifyChildDesiredSizeChanged()
- UIContainerControl.IUIElement.NotifyMouseLeaveEvent()
- UIContainerControl.AddPendingGraphicsInversion(Rectangle)
- UIContainerControl.AddPendingScrollOperation(Rectangle, Orientation, Int32)
- UIContainerControl.AddPendingScrollOperation(Rectangle, Int32, Int32)
- UIContainerControl.AddToInvalidatedRegion()
- UIContainerControl.AddToInvalidatedRegion(Rectangle)
- UIContainerControl.Arrange(Rectangle)
- UIContainerControl.ArrangeOverride(Size)
- UIContainerControl.ContainsLocation(Point)
- UIContainerControl.CreateChildren()
- UIContainerControl.DpiScaleChanged(SizeF)
- UIContainerControl.GetCursor(Point)
- UIContainerControl.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIContainerControl.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, Boolean>)
- UIContainerControl.Invalidate(InvalidationLevels, InvalidationTypes)
- UIContainerControl.InvalidateArrange()
- UIContainerControl.InvalidateMeasure()
- UIContainerControl.Measure(Graphics, Size)
- UIContainerControl.MeasureOverride(Graphics, Size)
- UIContainerControl.OnClick(EventArgs)
- UIContainerControl.OnDoubleClick(EventArgs)
- UIContainerControl.OnDpiChangedAfterParent(EventArgs)
- UIContainerControl.OnHandleCreated(EventArgs)
- UIContainerControl.OnLayout(LayoutEventArgs)
- UIContainerControl.OnLocationChanged(EventArgs)
- UIContainerControl.OnMouseCaptureChanged(EventArgs)
- UIContainerControl.OnMouseEnter(EventArgs)
- UIContainerControl.OnMouseHover(EventArgs)
- UIContainerControl.OnMouseLeave(EventArgs)
- UIContainerControl.OnMouseMove(MouseEventArgs)
- UIContainerControl.OnMouseUp(MouseEventArgs)
- UIContainerControl.OnMouseWheel(MouseEventArgs)
- UIContainerControl.OnPaint(PaintEventArgs)
- UIContainerControl.OnPaintBackground(PaintEventArgs)
- UIContainerControl.OnParentChanged()
- UIContainerControl.OnParentChanged(EventArgs)
- UIContainerControl.OnRenderChildElements(PaintEventArgs)
- UIContainerControl.OnResize(EventArgs)
- UIContainerControl.OnRightToLeftChanged(EventArgs)
- UIContainerControl.OnVisibleChanged(EventArgs)
- UIContainerControl.Render(PaintEventArgs)
- UIContainerControl.ResetDoubleBufferCanvas(Boolean)
- UIContainerControl.ResumePainting()
- UIContainerControl.SuspendPainting()
- UIContainerControl.TransformToAncestor(IUIElement)
- UIContainerControl.TransformToDescendant(IUIElement)
- UIContainerControl.UpdateCursor()
- UIContainerControl.UpdateLayout()
- UIContainerControl.OnDpiChangedBeforeParent(EventArgs)
- UIContainerControl.RescaleConstantsForDpi(Int32, Int32)
- UIContainerControl.IUIElement.CreateGraphics()
- UIContainerControl.ILogicalTreeNode.Children
- UIContainerControl.ILogicalTreeNode.Parent
- UIContainerControl.IUIControl.MouseCaptureElement
- UIContainerControl.IUIControl.Capture
- UIContainerControl.IUIElement.Bounds
- UIContainerControl.IUIElement.Size
- UIContainerControl.IUIElement.Visibility
- UIContainerControl.IUIElement.VisualOffset
- UIContainerControl.ActualHeight
- UIContainerControl.ActualWidth
- UIContainerControl.BackColor
- UIContainerControl.BackgroundImage
- UIContainerControl.CaptureMouseWhenPressed
- UIContainerControl.ClipBounds
- UIContainerControl.DesiredSize
- UIContainerControl.DpiScaleFactor
- UIContainerControl.Font
- UIContainerControl.ForeColor
- UIContainerControl.IsArrangeValid
- UIContainerControl.IsMeasureValid
- UIContainerControl.IsPaintValid
- UIContainerControl.IsRightToLeft
- UIContainerControl.LastMouseUpButton
- UIContainerControl.PaintingSuspended
- UIContainerControl.UseControlGraphicsForMeasure
- UIContainerControl.DpiChangedAfterParent
- UIContainerControl.DpiChangedBeforeParent