Class PathGradientBrush

PathGradientBrush class

Encapsulates a Brush object with a gradient. This class cannot be inherited.

public sealed class PathGradientBrush : PathGradientBrushBase

Constructors

Name	Description
PathGradientBrush(GraphicsPath)	Initializes a new instance of the `PathGradientBrush` class with the specified path.
PathGradientBrush(PointF[])	Initializes a new instance of the `PathGradientBrush` class with the specified points.
PathGradientBrush(Point[])	Initializes a new instance of the `PathGradientBrush` class with the specified points.
PathGradientBrush(PointF[], WrapMode)	Initializes a new instance of the `PathGradientBrush` class with the specified points and wrap mode.
PathGradientBrush(Point[], WrapMode)	Initializes a new instance of the `PathGradientBrush` class with the specified points and wrap mode.

Properties

Name	Description
Blend { get; set; }	Gets or sets a `Blend` that specifies positions and factors that define a custom falloff for the gradient.
CenterColor { get; set; }	Gets or sets the color at the center of the path gradient.
CenterPoint { get; set; }	Gets or sets the center point of the path gradient.
Disposed { get; }	Gets a value indicating whether this instance is disposed.
FocusScales { get; set; }	Gets or sets the focus point for the gradient falloff.
GraphicsPath { get; }	Gets the graphics path this brush was build upon.
IsTransformChanged { get; }	Gets a value indicating whether transformations were changed in some way. For example setting the transformation matrix or calling any of the methods altering the transformation matrix. The property is introduced for backward compatibility with GDI+.
Opacity { get; set; }	Gets or sets the brush opacity. The value should be between 0 and 1. Value of 0 means that brush is fully visible, value of 1 means the brush is fully opaque.
PathPoints { get; }	Gets the path points this brush was build upon.
SurroundColors { get; set; }	Gets or sets an array of colors that correspond to the points in the path this `PathGradientBrush` fills.
Transform { get; set; }	Gets or sets a copy `Matrix` that defines a local geometric transform for this `TransformBrush`.
WrapMode { get; set; }	Gets or sets a `WrapMode` enumeration that indicates the wrap mode for this `TransformBrush`.

Methods

Name	Description
virtual DeepClone()	Creates a new deep clone of the current `Brush`.
Dispose()	Disposes the current instance.
override Equals(object)	Check if objects are equal.
override GetHashCode()	Get hash code of the current object.
MultiplyTransform(Matrix)	Multiplies the `Matrix` that represents the local geometric transform of this `LinearGradientBrush` by the specified `Matrix` by prepending the specified `Matrix`.
MultiplyTransform(Matrix, MatrixOrder)	Multiplies the `Matrix` that represents the local geometric transform of this `LinearGradientBrush` by the specified `Matrix` in the specified order.
ResetTransform()	Resets the `Transform` property to identity.
RotateTransform(float)	Rotates the local geometric transform by the specified amount. This method prepends the rotation to the transform.
RotateTransform(float, MatrixOrder)	Rotates the local geometric transform by the specified amount in the specified order.
ScaleTransform(float, float)	Scales the local geometric transform by the specified amounts. This method prepends the scaling matrix to the transform.
ScaleTransform(float, float, MatrixOrder)	Scales the local geometric transform by the specified amounts in the specified order.
SetBlendTriangularShape(float)	Creates a gradient with a center color and a linear falloff to one surrounding color.
SetBlendTriangularShape(float, float)	Creates a gradient with a center color and a linear falloff to each surrounding color.
SetSigmaBellShape(float)	Creates a gradient brush that changes color starting from the center of the path outward to the path’s boundary. The transition from one color to another is based on a bell-shaped curve.
SetSigmaBellShape(float, float)	Creates a gradient brush that changes color starting from the center of the path outward to the path’s boundary. The transition from one color to another is based on a bell-shaped curve.
TranslateTransform(float, float)	Translates the local geometric transform by the specified dimensions. This method prepends the translation to the transform.
TranslateTransform(float, float, MatrixOrder)	Translates the local geometric transform by the specified dimensions in the specified order.

Remarks

The center color is white by default. A user can changed this value at any time later.

The surround colors array is initialized by single element containing white color by default. The surround colors may be changed later, however at least single element is required when setting up the surround colors.

See the Blend for more details about its initialization.