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

WizardRenderer Class

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

Provides a base renderer for the Wizard control.

[ToolboxBitmap(typeof(WizardRenderer))]
[TypeConverter(typeof(GenericExpandableNullableObjectConverter))]
public abstract class WizardRenderer : UIRenderer, IDisposable, IWizardRenderer, IUIRenderer
Inheritance:
object DisposableObjectBase UIRenderer object
Derived:
WindowsClassicWizardRenderer
Implements:
IDisposable IWizardRenderer IUIRenderer

Constructors

WizardRenderer()

Initializes a new instance of the class.

public WizardRenderer()

WizardRenderer(IWindowsColorScheme)

Initializes a new instance of the class.

protected WizardRenderer(IWindowsColorScheme colorScheme)
Parameter Type Description
colorScheme IWindowsColorScheme

The IWindowsColorScheme to use as a base for the colors.

Properties

ResetAllPropertiesOnSystemColorChange

Whether to reset all properties when a system color change event occurs.

public bool ResetAllPropertiesOnSystemColorChange { get; set; }

Property Value

bool:

true if all properties should be reset; otherwise, false.

WizardButtonContainerHeight

The height of a WizardButtonContainer.

public virtual int WizardButtonContainerHeight { get; set; }

Property Value

int

WizardInteriorPageHeaderHeight

The height of the interior page header.

public virtual int WizardInteriorPageHeaderHeight { get; set; }

Property Value

int

WizardInteriorPageMargin

The interior page margin.

public virtual int WizardInteriorPageMargin { get; set; }

Property Value

int

WizardSeparatorHeight

The height of a separator in a wizard.

public virtual int WizardSeparatorHeight { get; set; }

Property Value

int

Methods

DrawWizardBackground(PaintEventArgs, Rectangle, Wizard)

Draws the background of a Wizard.

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

OnSystemUserPreferenceColorChanged()

Occurs when user preferences are changed for the color category.

protected override void OnSystemUserPreferenceColorChanged()

Remarks

This method will only be invoked if IsSystemUserPreferenceColorChangeMonitored returns true.

ResetAll(bool)

Resets all property values to their defaults.

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

Whether to force resetting.

ResetResetAllPropertiesOnSystemColorChange()

Resets the ResetAllPropertiesOnSystemColorChange property to its default value.

public virtual void ResetResetAllPropertiesOnSystemColorChange()

ResetWizardButtonContainerHeight()

Resets the WizardButtonContainerHeight property to its default value.

public virtual void ResetWizardButtonContainerHeight()

ResetWizardInteriorPageHeaderHeight()

Resets the WizardInteriorPageHeaderHeight property to its default value.

public virtual void ResetWizardInteriorPageHeaderHeight()

ResetWizardInteriorPageMargin()

Resets the WizardInteriorPageMargin property to its default value.

public virtual void ResetWizardInteriorPageMargin()

ResetWizardSeparatorHeight()

Resets the WizardSeparatorHeight property to its default value.

public virtual void ResetWizardSeparatorHeight()

ShouldSerializeResetAllPropertiesOnSystemColorChange()

Indicates whether the ResetAllPropertiesOnSystemColorChange property should be persisted.

public virtual bool ShouldSerializeResetAllPropertiesOnSystemColorChange()

Returns

bool:

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

ShouldSerializeWizardButtonContainerHeight()

Indicates whether the WizardButtonContainerHeight property should be persisted.

public virtual bool ShouldSerializeWizardButtonContainerHeight()

Returns

bool:

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

ShouldSerializeWizardInteriorPageHeaderHeight()

Indicates whether the WizardInteriorPageHeaderHeight property should be persisted.

public virtual bool ShouldSerializeWizardInteriorPageHeaderHeight()

Returns

bool:

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

ShouldSerializeWizardInteriorPageMargin()

Indicates whether the WizardInteriorPageMargin property should be persisted.

public virtual bool ShouldSerializeWizardInteriorPageMargin()

Returns

bool:

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

ShouldSerializeWizardSeparatorHeight()

Indicates whether the WizardSeparatorHeight property should be persisted.

public virtual bool ShouldSerializeWizardSeparatorHeight()

Returns

bool:

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

Inherited Members

Extension Methods