GrapeCity.Documents.Drawing.RadialGradientBrush

Class RadialGradientBrush

Namespace

GrapeCity.Documents.Drawing

Assembly

GcDocs.Imaging.dll

Represents a radial gradient brush.

public class RadialGradientBrush : Brush

Inheritance

object

Brush

RadialGradientBrush

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

Constructors

RadialGradientBrush(RadialGradientBrush)

Creates a copy of a RadialGradientBrush object.

public RadialGradientBrush(RadialGradientBrush source)

Parameters

source RadialGradientBrush

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

RadialGradientBrush(Color, Color, PointF)

Initializes a new instance of the RadialGradientBrush class.

public RadialGradientBrush(Color startColor, Color endColor, PointF centerOfStartCircle)

Parameters

startColor System.Drawing.Color

The start gradient color.

endColor System.Drawing.Color

The end gradient color.

centerOfStartCircle System.Drawing.PointF

The center of the start circle that defines the beginning of the gradient.

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

RadialGradientBrush(Color, Color)

Initializes a new instance of the RadialGradientBrush class.

public RadialGradientBrush(Color startColor, Color endColor)

Parameters

startColor System.Drawing.Color

The start gradient color.

endColor System.Drawing.Color

The end gradient color.

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

Properties

CenterOfEndCircle

Gets or sets the center of the end circle that defines the end of the gradient.

(0, 0) is the top-left corner, (1, 1) is the bottom-right corner. The default is (0.5f, 0.5f).

This property only has effect if the RadiusOfEndCircle property is set.

public PointF CenterOfEndCircle { get; set; }

Property Value

System.Drawing.PointF

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

CenterOfStartCircle

Gets or sets the center of the start circle that defines the beginning of the gradient.

(0, 0) is the top-left corner, (1, 1) is the bottom-right corner.

If not specified, the center of the start circle coincides with CenterOfEndCircle.

public PointF? CenterOfStartCircle { get; set; }

Property Value

System.Drawing.PointF?

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

EndColor

Gets or sets the ending gradient color.

public Color EndColor { get; set; }

Property Value

System.Drawing.Color

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

ExtendEndCircle

Gets or sets a value indicating whether to extend gradient beyond the end circle.

This property only has effect if the RadiusOfEndCircle property is set.

The default is true.

public bool ExtendEndCircle { get; set; }

Property Value

bool

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

ExtendStartCircle

Gets or sets a value indicating whether to extend the gradient beyond the start circle.

This property only has effect if the RadiusOfEndCircle property is set.

The default is true.

public bool ExtendStartCircle { get; set; }

Property Value

bool

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

GradientStops

Gets or sets the collection of gradient stops.

public IList<GradientStop> GradientStops { get; set; }

Property Value

System.Collections.Generic.IList<T><GradientStop>

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

Normalize

Gets or sets a value indicating whether to normalize the brush ensuring that it renders in the same way on all supported target graphics (such as PDF, bitmap or SVG).

• If true, and the focal point is outside the end circle, it is moved to be on the end circle.
• If false, the focal point position is not adjusted if it is outside the end circle, and the result will depend on the implementation of the target GcGraphics.

The default is true.

public bool Normalize { get; set; }

Property Value

bool

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

RadiusOfEndCircle

Gets or sets the radius of the end circle that defines the end of the gradient, as a fraction of the normalized diagonal. The normalized diagonal length is calculated as sqrt(width² + height²) / sqrt(2).

Setting this property to a non-null value enables the following properties:

• CenterOfEndCircle
• RadiusOfStartCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

And the following properties are ignored if this property has a value:

• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

public float? RadiusOfEndCircle { get; set; }

Property Value

float?

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

RadiusOfStartCircle

Gets or sets the radius of the start circle that defines the beginning of the gradient, as a fraction of the normalized diagonal. The normalized diagonal length is calculated as sqrt(width² + height²) / sqrt(2).

This property only has effect if the RadiusOfEndCircle property is set.

The default is 0.

public float RadiusOfStartCircle { get; set; }

Property Value

float

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

StartColor

Gets or sets the starting gradient color.

public Color StartColor { get; set; }

Property Value

System.Drawing.Color

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

Visible

Gets a value indicating whether the brush is actually visible.

public override bool Visible { get; }

Property Value

bool

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

Methods

AreSemitransparentColorsUsed()

Returns a value indicating whether brush uses semi-transparent colors.

public bool AreSemitransparentColorsUsed()

Returns

bool

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.

SameBrush(Brush)

Returns True if the specified brush is the same as the current brush.

protected override bool SameBrush(Brush brush)

Parameters

brush Brush

Returns

bool

Remarks

Note that as of v5.0.0.771, the object model of RadialGradientBrush was expanded to better support radial gradient brushes available on different target graphics platforms (such as PDF, bitmap or SVG). The following new properties are added:

• CenterOfStartCircle
• RadiusOfStartCircle
• CenterOfEndCircle
• RadiusOfEndCircle
• ExtendStartCircle
• ExtendEndCircle
• Normalize

The following properties are still available for backwards compatibility, but are now hidden from IntelliSense and should not be used in new code:

• GrapeCity.Documents.Drawing.RadialGradientBrush.GradientOrigin
• GrapeCity.Documents.Drawing.RadialGradientBrush.CoverRectangle
• GrapeCity.Documents.Drawing.RadialGradientBrush.AllowEllipticGradients

These properties will be marked as obsolete in a future version, and may eventually be removed.