GradientBrush Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Media

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.

Edit

An abstract class that describes a gradient, composed of gradient stops.

public ref class GradientBrush : Brush

/// [Microsoft.UI.Xaml.Markup.ContentProperty(Name="GradientStops")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class GradientBrush : Brush

[Microsoft.UI.Xaml.Markup.ContentProperty(Name="GradientStops")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class GradientBrush : Brush

Public Class GradientBrush
Inherits Brush

Inheritance: Object Platform::Object IInspectable DependencyObject Brush GradientBrush

Derived: Microsoft.UI.Xaml.Media.LinearGradientBrush

Attributes: ContentPropertyAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Remarks

Use the GradientStops property to describe the color composition of a LinearGradientBrush where each GradientStop specifies a Color and an Offset. Each Offset value should be between 0 and 1.

Color values can be any value expressed as a named color or one of the conversion syntaxes.

GradientBrush derived classes

GradientBrush is the parent class for LinearGradientBrush.

Constructors

GradientBrush()

Provides base class initialization behavior for GradientBrush-derived classes.

Properties

ColorInterpolationMode	Gets or sets a ColorInterpolationMode enumeration value that specifies how the gradient's colors are interpolated.
ColorInterpolationModeProperty	Identifies the ColorInterpolationMode dependency property.
Dispatcher	Always returns `null` in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the `DispatcherQueue` that this object is associated with. The `DispatcherQueue` represents a facility that can access the `DependencyObject` on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)
GradientStops	Gets or sets the brush's gradient stops.
GradientStopsProperty	Identifies the GradientStops dependency property.
MappingMode	Gets or sets a BrushMappingMode enumeration value that specifies whether the positioning coordinates of the gradient brush are absolute or relative to the output area.
MappingModeProperty	Identifies the MappingMode dependency property.
Opacity	Gets or sets the degree of opacity of a Brush. (Inherited from Brush)
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.
SpreadMethodProperty	Identifies the SpreadMethod dependency property.
Transform	Gets or sets the transformation that is applied to the brush. (Inherited from Brush)

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)	Defines a property that can be animated. (Inherited from Brush)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)	When overridden in a derived class, defines a property that can be animated. (Inherited from Brush)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

Applies to

Share via