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

EllipseGradient Class

Namespace:
ActiproSoftware.UI.WinForms.Drawing
Assembly:
ActiproSoftware.Shared.WinForms.dll

Represents an ellipse gradient.

public class EllipseGradient : Gradient, ICloneable
Inheritance:
object BackgroundFill Gradient object
Implements:
ICloneable

Constructors

EllipseGradient()

Initializes an instance of the class.

public EllipseGradient()

EllipseGradient(EllipseGradient)

Initializes an instance of the class.

protected EllipseGradient(EllipseGradient copyFrom)
Parameter Type Description
copyFrom EllipseGradient

An instance of EllipseGradient which will be copied to initialize the new instance.

Remarks

This constructor used in support of Clone() for base classes to initialize their fields.

EllipseGradient(Color, Color)

Initializes an instance of the class.

public EllipseGradient(Color centerColor, Color outerColor)
Parameter Type Description
centerColor Color

The center color of the gradient.
outerColor Color

The outer color of the gradient.

EllipseGradient(Color, Color, Color)

Initializes an instance of the class.

public EllipseGradient(Color centerColor, Color outerColor, Color backColor)
Parameter Type Description
centerColor Color

The center color of the gradient.
outerColor Color

The outer color of the gradient.
backColor Color

The background color of the gradient.

Properties

BackColor

The background color of the gradient.

public Color BackColor { get; set; }

Property Value

Color

BackColorAlpha

The background color alpha value.

public byte BackColorAlpha { get; set; }

Property Value

byte

CenterColor

The center color of the gradient.

public Color CenterColor { get; set; }

Property Value

Color

CenterColorAlpha

The center color alpha value.

public byte CenterColorAlpha { get; set; }

Property Value

byte

OuterColor

The outer color of the gradient.

public Color OuterColor { get; set; }

Property Value

Color

OuterColorAlpha

The outer color alpha value.

public byte OuterColorAlpha { get; set; }

Property Value

byte

Methods

Clone()

Creates an exact duplicate of the BackgroundFill object.

public override BackgroundFill Clone()

Returns

BackgroundFill

Draw(Graphics, Rectangle, Rectangle, Color, Color)

Fills an area with the gradient.

public static void Draw(Graphics g, Rectangle bounds, Rectangle gradientBounds, Color centerColor, Color outerColor)
Parameter Type Description
g Graphics

The Graphics object used to paint.
bounds Rectangle

The bounds of the area to paint.
gradientBounds Rectangle

The bounds of the gradient effect.
centerColor Color

The center color of the gradient.
outerColor Color

The outer color of the gradient.

Draw(Graphics, Rectangle, Rectangle, Color, Color, Color)

Fills an area with the gradient.

public static void Draw(Graphics g, Rectangle bounds, Rectangle gradientBounds, Color centerColor, Color outerColor, Color backColor)
Parameter Type Description
g Graphics

The Graphics object used to paint.
bounds Rectangle

The bounds of the area to paint.
gradientBounds Rectangle

The bounds of the gradient effect.
centerColor Color

The center color of the gradient.
outerColor Color

The outer color of the gradient.
backColor Color

The background color of the gradient.

DrawScaled(Graphics, Rectangle, Rectangle, Sides, SizeF)

Fills an area with the background fill.

public override void DrawScaled(Graphics g, Rectangle bounds, Rectangle gradientBounds, Sides side, SizeF scaleFactor)
Parameter Type Description
g Graphics

The Graphics object used to paint.
bounds Rectangle

The bounds of the area to paint.
gradientBounds Rectangle

The Graphics object used to paint.
side Sides

The side with which the background fill should be oriented.
scaleFactor SizeF

The factor of the scale transform to be applied where Width is applied to the x-axis, and Height is applied to the y-axis.

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.

GetBrush(Rectangle, Sides)

Returns a Brush that represents the background fill.

public override Brush GetBrush(Rectangle bounds, Sides side)
Parameter Type Description
bounds Rectangle

The bounds of the area to paint.
side Sides

The side with which the background fill should be oriented.

Returns

Brush

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int:

A hash code for the current object.

ResetBackColor()

Resets the BackColor property to its default value.

public virtual void ResetBackColor()

ResetCenterColor()

Resets the CenterColor property to its default value.

public virtual void ResetCenterColor()

ResetOuterColor()

Resets the OuterColor property to its default value.

public virtual void ResetOuterColor()

ShouldSerializeBackColor()

Indicates whether the BackColor property should be persisted.

public virtual bool ShouldSerializeBackColor()

Returns

bool:

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

ShouldSerializeCenterColor()

Indicates whether the CenterColor property should be persisted.

public virtual bool ShouldSerializeCenterColor()

Returns

bool:

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

ShouldSerializeOuterColor()

Indicates whether the OuterColor property should be persisted.

public virtual bool ShouldSerializeOuterColor()

Returns

bool:

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

Inherited Members

Extension Methods