Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

WindowsClassicWizardRenderer Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.Wizard
Assembly:
ActiproSoftware.Wizard.WinForms.dll

Provides a renderer for the Wizard control that has a Windows Classic appearance.

public class WindowsClassicWizardRenderer : WizardRenderer, IDisposable, IWizardRenderer, IUIRenderer
Inheritance:
object DisposableObjectBase UIRenderer WizardRenderer object
Implements:
IDisposable IWizardRenderer IUIRenderer

Constructors

WindowsClassicWizardRenderer()

Initializes an instance of the class.

public WindowsClassicWizardRenderer()

WindowsClassicWizardRenderer(IWindowsColorScheme)

Initializes an instance of the class.

protected WindowsClassicWizardRenderer(IWindowsColorScheme colorScheme)
Parameter Type Description
colorScheme IWindowsColorScheme

The IWindowsColorScheme to use as a base for the colors.

Properties

WizardButtonContainerDefaultBackgroundFill

The BackgroundFill for a WizardButtonContainer.

public BackgroundFill? WizardButtonContainerDefaultBackgroundFill { get; set; }

Property Value

BackgroundFill

WizardExteriorPageDefaultBackgroundFill

The default BackgroundFill for an exterior page in a Wizard.

public BackgroundFill? WizardExteriorPageDefaultBackgroundFill { get; set; }

Property Value

BackgroundFill

WizardInteriorPageDefaultBackgroundFill

The default BackgroundFill for an interior page in a Wizard.

public BackgroundFill? WizardInteriorPageDefaultBackgroundFill { get; set; }

Property Value

BackgroundFill

WizardInteriorPageHeaderDefaultBackgroundFill

The default BackgroundFill for a WizardInteriorPageHeader.

public BackgroundFill? WizardInteriorPageHeaderDefaultBackgroundFill { get; set; }

Property Value

BackgroundFill

WizardInteriorPageHeaderDefaultImage

The default Image for a WizardInteriorPageHeader.

public Image? WizardInteriorPageHeaderDefaultImage { get; set; }

Property Value

Image

WizardInteriorPageHeaderImageSize

The Size in which each WizardInteriorPageHeaderImage should be drawn.

public Size WizardInteriorPageHeaderImageSize { get; set; }

Property Value

Size

WizardInteriorPageHeaderImageSizeToFit

Whether to automatically resize each WizardInteriorPageHeaderImage to the Size specified in the WizardInteriorPageHeaderImageSize property.

public bool WizardInteriorPageHeaderImageSizeToFit { get; set; }

Property Value

bool:

true if images should be resized to the WizardInteriorPageHeaderImageSize; otherwise, false.

WizardPageCaptionFont

The Font to use when drawing wizard page captions in an interior page header.

public virtual Font? WizardPageCaptionFont { get; set; }

Property Value

Font

Remarks

When null, text may not be rendered or a default system font may be used.

WizardPageCaptionForeColor

The foreground color of a wizard page caption in an interior page header.

public Color WizardPageCaptionForeColor { get; set; }

Property Value

Color

WizardPageCaptionOffset

The offset of a wizard page caption in an interior page header.

public virtual int WizardPageCaptionOffset { get; set; }

Property Value

int

WizardPageDescriptionFont

The Font to use when drawing wizard page descriptions in an interior page header.

public virtual Font? WizardPageDescriptionFont { get; set; }

Property Value

Font

Remarks

When null, text may not be rendered or a default system font may be used.

WizardPageDescriptionForeColor

The foreground color of a wizard page description in an interior page header.

public Color WizardPageDescriptionForeColor { get; set; }

Property Value

Color

WizardPageDescriptionOffset

The offset of a wizard page description in an interior page header.

public virtual int WizardPageDescriptionOffset { get; set; }

Property Value

int

WizardWelcomePageWatermarkDefaultBackgroundFill

The default BackgroundFill for the watermark area of a welcome page in a Wizard.

public BackgroundFill? WizardWelcomePageWatermarkDefaultBackgroundFill { get; set; }

Property Value

BackgroundFill

Methods

Dispose(bool)

Releases the unmanaged resources used by the object and optionally releases the managed resources.

protected override void Dispose(bool disposing)
Parameter Type Description
disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

This method is called by the public Dispose() method and the Finalize method. Dispose invokes this method with the disposing parameter set to true. Finalize invokes this method with disposing set to false.

DrawWizardBackground(PaintEventArgs, Rectangle, Wizard)

Draws the background of a Wizard.

public override void DrawWizardBackground(PaintEventArgs e, Rectangle bounds, Wizard wizard)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.
bounds Rectangle

The bounds in which to draw.
wizard Wizard

The Wizard that is being painted.

DrawWizardButtonContainerBackground(PaintEventArgs, Rectangle, WizardButtonContainer)

Draws the background of a WizardButtonContainer.

public override void DrawWizardButtonContainerBackground(PaintEventArgs e, Rectangle bounds, WizardButtonContainer buttonContainer)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.
bounds Rectangle

The bounds in which to draw.
buttonContainer WizardButtonContainer

The WizardButtonContainer that is being painted.

DrawWizardExteriorPageBackground(PaintEventArgs, Rectangle, WizardPage)

Draws the background of an exterior WizardPage.

public override void DrawWizardExteriorPageBackground(PaintEventArgs e, Rectangle bounds, WizardPage page)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.
bounds Rectangle

The bounds in which to draw.
page WizardPage

The WizardPage that is being painted.

DrawWizardInteriorPageBackground(PaintEventArgs, Rectangle, WizardPage)

Draws the background of an interior WizardPage.

public override void DrawWizardInteriorPageBackground(PaintEventArgs e, Rectangle bounds, WizardPage page)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.
bounds Rectangle

The bounds in which to draw.
page WizardPage

The WizardPage that is being painted.

DrawWizardInteriorPageHeaderBackground(PaintEventArgs, Rectangle, WizardInteriorPageHeader)

Draws the background of a WizardInteriorPageHeader.

public override void DrawWizardInteriorPageHeaderBackground(PaintEventArgs e, Rectangle bounds, WizardInteriorPageHeader header)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.
bounds Rectangle

The bounds in which to draw.
header WizardInteriorPageHeader

The WizardInteriorPageHeader that is being painted.

DrawWizardInteriorPageHeaderForeground(PaintEventArgs, Rectangle, WizardInteriorPageHeader)

Draws the foreground of a WizardInteriorPageHeader.

public override void DrawWizardInteriorPageHeaderForeground(PaintEventArgs e, Rectangle bounds, WizardInteriorPageHeader header)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.
bounds Rectangle

The bounds in which to draw.
header WizardInteriorPageHeader

The WizardInteriorPageHeader that is being painted.

DrawWizardSeparator(PaintEventArgs, Rectangle, Wizard)

Draws a separator in a Wizard.

public override void DrawWizardSeparator(PaintEventArgs e, Rectangle bounds, Wizard wizard)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.
bounds Rectangle

The bounds in which to draw.
wizard Wizard

The Wizard that is being painted.

DrawWizardWelcomePageBackground(PaintEventArgs, Rectangle, WizardWelcomePage)

Draws the background of a welcome WizardPage.

public override void DrawWizardWelcomePageBackground(PaintEventArgs e, Rectangle bounds, WizardWelcomePage page)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.
bounds Rectangle

The bounds in which to draw.
page WizardWelcomePage

The WizardPage that is being painted.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)
Parameter Type Description
obj object

The object to compare with the current object.

Returns

bool:

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int:

A hash code for the current object.

ResetAll(bool)

Resets all property values to their defaults.

protected override void ResetAll(bool force)
Parameter Type Description
force bool

Whether to force resetting.

ResetWizardButtonContainerDefaultBackgroundFill()

Resets the WizardButtonContainerDefaultBackgroundFill property to its default value.

public virtual void ResetWizardButtonContainerDefaultBackgroundFill()

ResetWizardExteriorPageDefaultBackgroundFill()

Resets the WizardExteriorPageDefaultBackgroundFill property to its default value.

public virtual void ResetWizardExteriorPageDefaultBackgroundFill()

ResetWizardInteriorPageDefaultBackgroundFill()

Resets the WizardInteriorPageDefaultBackgroundFill property to its default value.

public virtual void ResetWizardInteriorPageDefaultBackgroundFill()

ResetWizardInteriorPageHeaderDefaultBackgroundFill()

Resets the WizardInteriorPageHeaderDefaultBackgroundFill property to its default value.

public virtual void ResetWizardInteriorPageHeaderDefaultBackgroundFill()

ResetWizardInteriorPageHeaderDefaultImage()

Resets the WizardInteriorPageHeaderDefaultImage property to its default value.

public virtual void ResetWizardInteriorPageHeaderDefaultImage()

ResetWizardInteriorPageHeaderImageSize()

Resets the WizardInteriorPageHeaderImageSize property to its default value.

public virtual void ResetWizardInteriorPageHeaderImageSize()

ResetWizardInteriorPageHeaderImageSizeToFit()

Resets the WizardInteriorPageHeaderImageSizeToFit property to its default value.

public virtual void ResetWizardInteriorPageHeaderImageSizeToFit()

ResetWizardPageCaptionFont()

Resets the WizardPageCaptionFont property to its default value.

public virtual void ResetWizardPageCaptionFont()

ResetWizardPageCaptionForeColor()

Resets the WizardPageCaptionForeColor property to its default value.

public virtual void ResetWizardPageCaptionForeColor()

ResetWizardPageCaptionOffset()

Resets the WizardPageCaptionOffset property to its default value.

public virtual void ResetWizardPageCaptionOffset()

ResetWizardPageDescriptionFont()

Resets the WizardPageDescriptionFont property to its default value.

public virtual void ResetWizardPageDescriptionFont()

ResetWizardPageDescriptionForeColor()

Resets the WizardPageDescriptionForeColor property to its default value.

public virtual void ResetWizardPageDescriptionForeColor()

ResetWizardPageDescriptionOffset()

Resets the WizardPageDescriptionOffset property to its default value.

public virtual void ResetWizardPageDescriptionOffset()

ResetWizardWelcomePageWatermarkDefaultBackgroundFill()

Resets the WizardWelcomePageWatermarkDefaultBackgroundFill property to its default value.

public virtual void ResetWizardWelcomePageWatermarkDefaultBackgroundFill()

ShouldSerializeWizardButtonContainerDefaultBackgroundFill()

Indicates whether the WizardButtonContainerDefaultBackgroundFill property should be persisted.

public virtual bool ShouldSerializeWizardButtonContainerDefaultBackgroundFill()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardExteriorPageDefaultBackgroundFill()

Indicates whether the WizardExteriorPageDefaultBackgroundFill property should be persisted.

public virtual bool ShouldSerializeWizardExteriorPageDefaultBackgroundFill()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardInteriorPageDefaultBackgroundFill()

Indicates whether the WizardInteriorPageDefaultBackgroundFill property should be persisted.

public virtual bool ShouldSerializeWizardInteriorPageDefaultBackgroundFill()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardInteriorPageHeaderDefaultBackgroundFill()

Indicates whether the WizardInteriorPageHeaderDefaultBackgroundFill property should be persisted.

public virtual bool ShouldSerializeWizardInteriorPageHeaderDefaultBackgroundFill()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardInteriorPageHeaderDefaultImage()

Indicates whether the WizardInteriorPageHeaderDefaultImage property should be persisted.

public virtual bool ShouldSerializeWizardInteriorPageHeaderDefaultImage()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardInteriorPageHeaderImageSize()

Indicates whether the WizardInteriorPageHeaderImageSize property should be persisted.

public virtual bool ShouldSerializeWizardInteriorPageHeaderImageSize()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardInteriorPageHeaderImageSizeToFit()

Indicates whether the WizardInteriorPageHeaderImageSizeToFit property should be persisted.

public virtual bool ShouldSerializeWizardInteriorPageHeaderImageSizeToFit()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardPageCaptionFont()

Indicates whether the WizardPageCaptionFont property should be persisted.

public virtual bool ShouldSerializeWizardPageCaptionFont()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardPageCaptionForeColor()

Indicates whether the WizardPageCaptionForeColor property should be persisted.

public virtual bool ShouldSerializeWizardPageCaptionForeColor()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardPageCaptionOffset()

Indicates whether the WizardPageCaptionOffset property should be persisted.

public virtual bool ShouldSerializeWizardPageCaptionOffset()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardPageDescriptionFont()

Indicates whether the WizardPageDescriptionFont property should be persisted.

public virtual bool ShouldSerializeWizardPageDescriptionFont()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardPageDescriptionForeColor()

Indicates whether the WizardPageDescriptionForeColor property should be persisted.

public virtual bool ShouldSerializeWizardPageDescriptionForeColor()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardPageDescriptionOffset()

Indicates whether the WizardPageDescriptionOffset property should be persisted.

public virtual bool ShouldSerializeWizardPageDescriptionOffset()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeWizardWelcomePageWatermarkDefaultBackgroundFill()

Indicates whether the WizardWelcomePageWatermarkDefaultBackgroundFill property should be persisted.

public virtual bool ShouldSerializeWizardWelcomePageWatermarkDefaultBackgroundFill()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

Inherited Members

Extension Methods