Skip to main content
.NET Framework Class Library
LinearGradientBrush Class

Paints an area with a linear gradient.

Namespace:   System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
Syntax
Public NotInheritable Class LinearGradientBrush _
	Inherits [%$TOPIC/ms635198_en-us_VS_110_2_0_0_0_0%]
public sealed class LinearGradientBrush : [%$TOPIC/ms635198_en-us_VS_110_2_0_1_0_0%]
public ref class LinearGradientBrush sealed : public [%$TOPIC/ms635198_en-us_VS_110_2_0_2_0_0%]
[<[%$TOPIC/ms635198_en-us_VS_110_2_0_3_0_0%]>]
type LinearGradientBrush =  
    class 
        inherit [%$TOPIC/ms635198_en-us_VS_110_2_0_3_0_1%] 
    end
public final class LinearGradientBrush extends [%$TOPIC/ms635198_en-us_VS_110_2_0_4_0_0%]
<LinearGradientBrush>
  [%$TOPIC/ms635198_en-us_VS_110_2_0_5_0_0%]
</LinearGradientBrush>

The LinearGradientBrush type exposes the following members.

Constructors
  NameDescription
Public method LinearGradientBrushInitializes a new instance of the LinearGradientBrush class.
Public method LinearGradientBrush(GradientStopCollection)Initializes a new instance of the LinearGradientBrush class that has the specified gradient stops.
Public method LinearGradientBrush(GradientStopCollection, Double)Initializes a new instance of the LinearGradientBrush class that has the specified GradientStopCollection and angle.
Public method LinearGradientBrush(Color, Color, Double)Initializes a new instance of the LinearGradientBrush class that has the specified start Color, end Color, and angle.
Public method LinearGradientBrush(GradientStopCollection, Point, Point)Initializes a new instance of the LinearGradientBrush class that has the specified gradient stops, StartPoint, and EndPoint.
Public method LinearGradientBrush(Color, Color, Point, Point)Initializes a new instance of the LinearGradientBrush class that has the specified start Color, end Color, StartPoint, and EndPoint.
Top
Properties
  NameDescription
Public property CanFreezeGets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
Public property ColorInterpolationModeGets or sets a ColorInterpolationMode enumeration that specifies how the gradient's colors are interpolated. (Inherited from GradientBrush.)
Public property DependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public property DispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property EndPointGets or sets the ending two-dimensional coordinates of the linear gradient.
Public property GradientStopsGets or sets the brush's gradient stops. (Inherited from GradientBrush.)
Public property HasAnimatedPropertiesGets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
Public property IsFrozenGets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
Public property IsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public property 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.)
Public property Opacity Gets or sets the degree of opacity of a Brush. (Inherited from Brush.)
Public property RelativeTransformGets or sets the transformation that is applied to the brush using relative coordinates. (Inherited from Brush.)
Public property 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.)
Public property StartPointGets or sets the starting two-dimensional coordinates of the linear gradient.
Public property 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.)
Top
Methods
  NameDescription
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method CheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method ClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public method ClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public method CloneCreates a modifiable clone of this LinearGradientBrush, 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.
Public method CloneCurrentValueCreates a modifiable clone of this LinearGradientBrush object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.
Public method CoerceValueCoerces 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.)
Public method EqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Public method FreezeMakes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Public method GetAnimationBaseValueReturns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
Public method GetAsFrozenCreates 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.)
Public method GetCurrentValueAsFrozenCreates 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.)
Public method GetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public method GetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method GetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public method InvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Public method ReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Public method SetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public method SetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public method 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.)
Protected method ShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public method ToString Return string representation of this Brush. (Inherited from Brush.)
Public method ToString(IFormatProvider) Creates a string representation of this object based on the specified culture-specific formatting information. (Inherited from Brush.)
Public method VerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
Events
  NameDescription
Public event ChangedOccurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
Top
Fields
  NameDescription
Public field Static member EndPointPropertyIdentifies the EndPoint dependency property.
Public field Static member StartPointPropertyIdentifies the StartPoint dependency property.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method IFormattableToStringFormats the value of the current instance using the specified format. (Inherited from Brush.)
Top
Remarks

A LinearGradientBrush paints an area with a linear gradient. A linear gradient defines a gradient along a line. The line's end points are defined by the StartPoint and EndPoint properties of the linear gradient. A LinearGradientBrush brush paints its GradientStops along this line.

The default linear gradient is diagonal. In the default, the StartPoint of a linear gradient is (0,0), the upper-left corner of the area being painted, and its EndPoint is (1,1), the lower-right corner of the area being painted. The colors in the resulting gradient are interpolated along the diagonal path.

The following illustration shows a diagonal gradient. A line was added to highlight the interpolation path of the gradient from the start point to the end point.

A diagonal linear gradient

Gradient axis for a diagonal linear gradient

The next illustration shows the same linear gradient, but with highlighted gradient stops.

A diagonal linear gradient with highlighted gradient stops

Gradient stops in a linear gradient

It is possible to specify a gradient axis that does not completely fill area being painted. When this occurs, the SpreadMethod property determines how the remaining area is painted.

Freezable Features

A LinearGradientBrush is a type of Freezable object and therefore can be frozen to improve performance. For information about Freezable features, such as freezing and cloning, see Freezable Objects Overview.

Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
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.