RadialGradientBrush Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
public ref class RadialGradientBrush sealed : System::Windows::Media::GradientBrushpublic sealed class RadialGradientBrush : System.Windows.Media.GradientBrushtype RadialGradientBrush = class
inherit GradientBrushPublic NotInheritable Class RadialGradientBrush
Inherits GradientBrush- Inheritance
-
RadialGradientBrush
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 SpreadMethod set to Pad.
Radial gradient with a highlighted focal point
Note
RadialGradientBrush objects are rendered using hardware acceleration on Tier 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 resources, 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.
Constructors
| RadialGradientBrush() |
Initializes a new instance of the RadialGradientBrush class. |
| RadialGradientBrush(Color, Color) |
Initializes a new instance of the RadialGradientBrush class with the specified start and stop colors. |
| RadialGradientBrush(GradientStopCollection) |
Initializes a new instance of the RadialGradientBrush class that has the specified gradient stops. |
Fields
| CenterProperty |
Identifies the Center dependency property. |
| GradientOriginProperty |
Identifies the GradientOrigin dependency property. |
| RadiusXProperty |
Identifies the RadiusX dependency property. |
| RadiusYProperty |
Identifies the RadiusY dependency property. |
Properties
| CanFreeze |
Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable) |
| Center |
Gets or sets the center of the outermost circle of the radial gradient. |
| ColorInterpolationMode |
Gets or sets a ColorInterpolationMode enumeration that specifies how the gradient's colors are interpolated. (Inherited from GradientBrush) |
| DependencyObjectType |
Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject) |
| Dispatcher |
Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject) |
| GradientOrigin |
Gets or sets the location of the two-dimensional focal point that defines the beginning of the gradient. |
| GradientStops |
Gets or sets the brush's gradient stops. (Inherited from GradientBrush) |
| HasAnimatedProperties |
Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable) |
| IsFrozen |
Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable) |
| IsSealed |
Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject) |
| MappingMode |
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) |
| Opacity |
Gets or sets the degree of opacity of a Brush. (Inherited from Brush) |
| RadiusX |
Gets or sets the horizontal radius of the outermost circle of the radial gradient. |
| RadiusY |
Gets or sets the vertical radius of the outermost circle of a radial gradient. |
| RelativeTransform |
Gets or sets the transformation that is applied to the brush using relative coordinates. (Inherited from Brush) |
| SpreadMethod |
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) |
| Transform |
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
| ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) |
Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable) |
| ApplyAnimationClock(DependencyProperty, AnimationClock) |
Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable) |
| BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) |
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) |
| BeginAnimation(DependencyProperty, AnimationTimeline) |
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) |
| CheckAccess() |
Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| ClearValue(DependencyProperty) |
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject) |
| ClearValue(DependencyPropertyKey) |
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject) |
| 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. |
| CloneCore(Freezable) |
Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable) |
| 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. |
| CloneCurrentValueCore(Freezable) |
Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from Freezable) |
| CoerceValue(DependencyProperty) |
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) |
| CreateInstance() |
Initializes a new instance of the Freezable class. (Inherited from Freezable) |
| CreateInstanceCore() |
When implemented in a derived class, creates a new instance of the Freezable derived class. (Inherited from Freezable) |
| Equals(Object) |
Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject) |
| Freeze() |
Makes the current object unmodifiable and sets its IsFrozen property to |
| FreezeCore(Boolean) |
Makes this Animatable object unmodifiable or determines whether it can be made unmodifiable. (Inherited from Animatable) |
| GetAnimationBaseValue(DependencyProperty) |
Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable) |
| 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) |
| GetAsFrozenCore(Freezable) |
Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. (Inherited from Freezable) |
| 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) |
| GetCurrentValueAsFrozenCore(Freezable) |
Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. (Inherited from Freezable) |
| GetHashCode() |
Gets a hash code for this DependencyObject. (Inherited from DependencyObject) |
| GetLocalValueEnumerator() |
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject) |
| InvalidateProperty(DependencyProperty) |
Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnChanged() |
Called when the current Freezable object is modified. (Inherited from Freezable) |
| OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) |
This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable) |
| OnFreezablePropertyChanged(DependencyObject, DependencyObject) |
Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable) |
| OnPropertyChanged(DependencyPropertyChangedEventArgs) |
Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable) |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject) |
| ReadPreamble() |
Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable) |
| SetCurrentValue(DependencyProperty, Object) |
Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject) |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject) |
| SetValue(DependencyPropertyKey, Object) |
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject) |
| ShouldSerializeProperty(DependencyProperty) |
Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject) |
| ToString() |
Return string representation of this Brush. (Inherited from Brush) |
| ToString(IFormatProvider) |
Creates a string representation of this object based on the specified culture-specific formatting information. (Inherited from Brush) |
| VerifyAccess() |
Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| WritePostscript() |
Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable) |
| WritePreamble() |
Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable) |
Events
| Changed |
Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable) |
Explicit Interface Implementations
| IFormattable.ToString(String, IFormatProvider) |
Formats the value of the current instance using the specified format. (Inherited from Brush) |
