LinearGradientBrush LinearGradientBrush LinearGradientBrush LinearGradientBrush Class

Definition

Paints an area with a linear gradient.

public : sealed class LinearGradientBrush : GradientBrush, ILinearGradientBrushpublic sealed class LinearGradientBrush : GradientBrush, ILinearGradientBrushPublic NotInheritable Class LinearGradientBrush Inherits GradientBrush Implements ILinearGradientBrush// This API is not available in Javascript.
<LinearGradientBrush ...>
  oneOrMoreGradientStops
</LinearGradientBrush
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited methods

Inherited properties

Examples

This example creates a linear gradient with four colors and uses it to paint a Rectangle.

<StackPanel>
  <!-- This rectangle is painted with a vertical linear gradient. -->
  <Rectangle Width="200" Height="100">
    <Rectangle.Fill>
      <LinearGradientBrush StartPoint="0.5,0" EndPoint="0.5,1">
        <GradientStop Color="Yellow" Offset="0.0" />
        <GradientStop Color="Red" Offset="0.25" />
        <GradientStop Color="Blue" Offset="0.75" />
        <GradientStop Color="LimeGreen" Offset="1.0" />
      </LinearGradientBrush>
    </Rectangle.Fill>
  </Rectangle>
</StackPanel>

Gradient axis for a vertical gradient

Remarks

LinearGradientBrush is a type of Brush that is used for many possible UI properties that use a Brush to fill some or all of an object's visual area in app UI. Examples of some of the most commonly-used properties that use a Brush value include: Control.Background, Control.Foreground, Shape.Fill, Control.BorderBrush, Panel.Background, TextBlock.Foreground. LinearGradientBrush is an alternative to the more commonly used SolidColorBrush type.

The StartPoint and EndPoint properties of LinearGradientBrush describe two points in a relative coordinate space. This creates an orientation for the gradient, and typically this specifies a horizontal gradient, or a vertical gradient. A diagonal gradient can also be used. A LinearGradientBrush typically has two or more GradientStop values for the GradientStops property (an ordered collection). Each GradientStop specifies a Color and an Offset. Offset represents a position between 0 (the StartPoint ) and 1 (the EndPoint ) along the gradient, and the actual pixel length of the brush and its gradient are adjusted based on the UI where you apply your LinearGradientBrush as a value. For more info on how Offset values are defined and how Offset, StartPoint and EndPoint are related, see Use brushes. It's common to use

You can use the Transparent value for one of the GradientStop colors. Although this doesn't visually apply any changes to UI (it's transparent), that point is detectable for hit-testing purposes. For more info on hit testing, see "Hit testing" section of Mouse interactions.

The GradientStop values of a LinearGradientBrush can be animated as part of transitions or decorative animations. Use one of the dedicated animation types that can animate a Color value. This usually involves having .(GradientStop.Color) be a part of a longer property path for a Storyboard.TargetProperty value. For more info on property targeting and how to animate properties that use Brush values, see Storyboarded animations.

Brushes as XAML resources

Each of the Brush types that can be declared in XAML (SolidColorBrush, LinearGradientBrush, ImageBrush ) is intended to be defined as a resource, so that you can reuse that brush as a resource throughout your app. The XAML syntax shown for Brush types is appropriate for defining the brush as a resource. When you declare a brush as a resource, you also need an x:Key attribute that you'll later use to refer to that resource from other UI definitions. For more info on XAML resources and how to use x:Key attribute, see ResourceDictionary and XAML resource references.

The advantage of declaring brushes as resources is that it reduces the number of runtime objects that are needed to construct a UI: the brush is now shared as a common resource that's providing values for multiple parts of the object graph.

If you look at the existing control template definitions for Windows Runtime XAML controls, you'll see that the templates use brush resources extensively (although these are usually SolidColorBrush, not LinearGradientBrush ). Many of these resources are system resources, and they use the {ThemeResource} markup extension for the resource reference rather than {StaticResource} markup extension. For more info on how to use system resource brushes in your own control template XAML, see XAML theme resources.

Constructors

LinearGradientBrush() LinearGradientBrush() LinearGradientBrush() LinearGradientBrush()

Initializes a new instance of the LinearGradientBrush class.

public : LinearGradientBrush()public LinearGradientBrush()Public Sub New()// This API is not available in Javascript.

LinearGradientBrush(GradientStopCollection, Double) LinearGradientBrush(GradientStopCollection, Double) LinearGradientBrush(GradientStopCollection, Double) LinearGradientBrush(GradientStopCollection, Double)

Initializes a new instance of the LinearGradientBrush class that has the specified GradientStopCollection and angle.

public : LinearGradientBrush(GradientStopCollection gradientStopCollection, double angle)public LinearGradientBrush(GradientStopCollection gradientStopCollection, Double angle)Public Sub New(gradientStopCollection As GradientStopCollection, angle As Double)// This API is not available in Javascript.
Parameters
angle
double Double Double Double

A System.Double that represents the angle, in degrees, of the gradient. A value of 0 creates a horizontal gradient, and a value of 90 creates a vertical gradient. Negative values are permitted, as are values over 360 (which are treated as mod 360).

Properties

EndPoint EndPoint EndPoint EndPoint

Gets or sets the ending two-dimensional coordinates of the linear gradient.

public : Point EndPoint { get; set; }public Point EndPoint { get; set; }Public ReadWrite Property EndPoint As Point// This API is not available in Javascript.
<LinearGradientBrush EndPoint="x,y"/>
Value
Point Point Point Point

The ending two-dimensional coordinates of the linear gradient. The default is a Point with value 1,1.

EndPointProperty EndPointProperty EndPointProperty EndPointProperty

Identifies the EndPoint dependency property.

public : static DependencyProperty EndPointProperty { get; }public static DependencyProperty EndPointProperty { get; }Public Static ReadOnly Property EndPointProperty As DependencyProperty// This API is not available in Javascript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the EndPoint dependency property.

StartPoint StartPoint StartPoint StartPoint

Gets or sets the starting two-dimensional coordinates of the linear gradient.

public : Point StartPoint { get; set; }public Point StartPoint { get; set; }Public ReadWrite Property StartPoint As Point// This API is not available in Javascript.
<LinearGradientBrush StartPoint="x,y"/>
Value
Point Point Point Point

The starting two-dimensional coordinates for the linear gradient. The default is a Point with value 0,0.

StartPointProperty StartPointProperty StartPointProperty StartPointProperty

Identifies the StartPoint dependency property.

public : static DependencyProperty StartPointProperty { get; }public static DependencyProperty StartPointProperty { get; }Public Static ReadOnly Property StartPointProperty As DependencyProperty// This API is not available in Javascript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the StartPoint dependency property.

See Also