Class PathGradientBrushBase

PathGradientBrushBase class

Represents a Brush with base path gradient functionality.

public abstract class PathGradientBrushBase : TransformBrush

Properties

NameDescription
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.
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

NameDescription
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.
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

Note that when creating the PathGradientBrushBase class it should be initialized with 2 points at least. The internal path created will always be a closed figure, the last point connects the first point. That shape is filled with this PathGradientBrushBase. The GDI+ implementation throws an OutOfMemoryException when passing in empty arrays or points set having the same coordinates. The PathGradientBrushBase throws an exception when points array contain less than 2 points, the ArgumentException is thrown rather than OutOfMemoryException when points array is unacceptable. The center point is calculated as a center of mass for the passed in points by default. A user can change this point later. The focus scales is an empty point (0.0, 0.0) by default.

See Also