Skip to main content
RadialGradientBrush Class
 

Paints an area with a radial gradient. A focal point defines the beginning of the gradient, and a circle defines the end point of the gradient.

Namespace:   System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)

Inheritance Hierarchy
SystemObject
   System.Windows.ThreadingDispatcherObject
     System.WindowsDependencyObject
       System.WindowsFreezable
         System.Windows.Media.AnimationAnimatable
           System.Windows.MediaBrush
             System.Windows.MediaGradientBrush
              System.Windows.MediaRadialGradientBrush

Syntax
public sealed class RadialGradientBrush : GradientBrush
public ref class RadialGradientBrush sealed : GradientBrush
[<Sealed>]
type RadialGradientBrush = 
    class
        inherit GradientBrush
    end
Public NotInheritable Class RadialGradientBrush
	Inherits GradientBrush
Constructors
NameDescription
System_CAPS_pubmethod RadialGradientBrush

Initializes a new instance of the RadialGradientBrush class.

System_CAPS_pubmethod RadialGradientBrush

Initializes a new instance of the RadialGradientBrush class with the specified start and stop colors.

System_CAPS_pubmethod RadialGradientBrush

Initializes a new instance of the RadialGradientBrush class that has the specified gradient stops.

Properties
NameDescription
System_CAPS_pubproperty

Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)

System_CAPS_pubproperty

Gets or sets the center of the outermost circle of the radial gradient.

System_CAPS_pubproperty

Gets or sets a ColorInterpolationMode enumeration that specifies how the gradient's colors are interpolated. (Inherited from GradientBrush.)

System_CAPS_pubproperty

Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)

System_CAPS_pubproperty

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubproperty

Gets or sets the location of the two-dimensional focal point that defines the beginning of the gradient.

System_CAPS_pubproperty

Gets or sets the brush's gradient stops. (Inherited from GradientBrush.)

System_CAPS_pubproperty

Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.)

System_CAPS_pubproperty

Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)

System_CAPS_pubproperty

Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)

System_CAPS_pubproperty

Gets or sets a BrushMappingMode enumeration that specifies whether the gradient brush's positioning coordinates are absolute or relative to the output area. (Inherited from GradientBrush.)

System_CAPS_pubproperty

Gets or sets the degree of opacity of a Brush. (Inherited from Brush.)

System_CAPS_pubproperty

Gets or sets the horizontal radius of the outermost circle of the radial gradient.

System_CAPS_pubproperty

Gets or sets the vertical radius of the outermost circle of a radial gradient.

System_CAPS_pubproperty

Gets or sets the transformation that is applied to the brush using relative coordinates. (Inherited from Brush.)

System_CAPS_pubproperty

Gets or sets the type of spread method that specifies how to draw a gradient that starts or ends inside the bounds of the object to be painted. (Inherited from GradientBrush.)

System_CAPS_pubproperty

Gets or sets the transformation that is applied to the brush. This transformation is applied after the brush's output has been mapped and positioned. (Inherited from Brush.)

Methods
NameDescription
System_CAPS_pubmethod ApplyAnimationClock

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)

System_CAPS_pubmethod ApplyAnimationClock

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.)

System_CAPS_pubmethod BeginAnimation

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)

System_CAPS_pubmethod BeginAnimation

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)

System_CAPS_pubmethod CheckAccess

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethod ClearValue

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethod ClearValue

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)

System_CAPS_pubmethod Clone

Creates a modifiable clone of this RadialGradientBrush, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.

System_CAPS_pubmethod CloneCurrentValue

Creates a modifiable clone of this RadialGradientBrush object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.

System_CAPS_pubmethod CoerceValue

Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethod Equals

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethod Freeze

Makes the current object unmodifiable and sets its property to true. (Inherited from Freezable.)

System_CAPS_pubmethod GetAnimationBaseValue

Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.)

System_CAPS_pubmethod GetAsFrozen

Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)

System_CAPS_pubmethod GetCurrentValueAsFrozen

Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.(Inherited from Freezable.)

System_CAPS_pubmethod GetHashCode

Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethod GetLocalValueEnumerator

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod GetValue

Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethod InvalidateProperty

Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)

System_CAPS_pubmethod ReadLocalValue

Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)

System_CAPS_pubmethod SetCurrentValue

Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)

System_CAPS_pubmethod SetValue

Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethod SetValue

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)

System_CAPS_protmethod ShouldSerializeProperty

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)

System_CAPS_pubmethod ToString

Return string representation of this Brush. (Inherited from Brush.)

System_CAPS_pubmethod ToString

Creates a string representation of this object based on the specified culture-specific formatting information. (Inherited from Brush.)

System_CAPS_pubmethod VerifyAccess

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

Fields
NameDescription
System_CAPS_pubfield System_CAPS_static CenterProperty

Identifies the  dependency property.

System_CAPS_pubfield System_CAPS_static GradientOriginProperty

Identifies the  dependency property.

System_CAPS_pubfield System_CAPS_static RadiusXProperty

Identifies the  dependency property.

System_CAPS_pubfield System_CAPS_static RadiusYProperty

Identifies the  dependency property.

Events
NameDescription
System_CAPS_pubevent Changed

Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)

Explicit Interface Implementations
NameDescription
System_CAPS_pubinterface System_CAPS_privmethod IFormattableToString

Formats the value of the current instance using the specified format.(Inherited from Brush.)

Remarks

The RadialGradientBrush is similar in programming model to the LinearGradientBrush. However, the linear gradient has a start and an end point to define the gradient vector, while the radial gradient has a circle, along with a focal point, to define the gradient behavior. The circle defines the end point of the gradient. In other words, a gradient stop at 1.0 defines the color at the circle's circumference. The focal point defines the center of the gradient. A gradient stop at 0.0 defines the color at the focal point.

The following image shows a rectangle filled with a radial gradient. The radial gradient that goes from white to gray. The outside circle represents the gradient circle while the red dot denotes the focal point. This gradient has its set to Pad.

A radial gradient with highlighted components

Radial gradient with a highlighted focal point

System_CAPS_noteNote

RadialGradientBrush objects are rendered using hardware acceleration on 2 systems. For more information about hardware tiers, see Graphics Rendering Tiers.

Freezable Features

Because it inherits from the Freezable class, the RadialGradientBrush class provides several special features: RadialGradientBrush objects can be declared as , shared among multiple objects, made read-only to improve performance, cloned, and made thread safe. For more information about the different features provided by Freezable objects, see Freezable Objects Overview.

Version Information
.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top