Brush Class

Definition

Namespace:

Windows.UI.Xaml.Media

Defines objects used to paint graphical objects. Classes that derive from Brush describe how the area is painted.

public ref class Brush : DependencyObject, IAnimationObject

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Brush : DependencyObject, IAnimationObject

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class Brush : DependencyObject, IAnimationObject

Public Class Brush
Inherits DependencyObject
Implements IAnimationObject

<object property="predefinedColorName"/>
- or -
<object property="#rgb"/>
- or -
<object property="#argb"/>
- or -
<object property="#rrggbb"/>
- or -
<object property="#aarrggbb"/>
- or -
<object property="sc#scR,scG,scB"/>
- or -
<object property="sc#scA,scR,scG,scB"/>

Inheritance

Object Platform::Object IInspectable DependencyObject Brush

Derived

Windows.UI.Xaml.Media.GradientBrush

Windows.UI.Xaml.Media.SolidColorBrush

Windows.UI.Xaml.Media.TileBrush

Windows.UI.Xaml.Media.XamlCompositionBrushBase

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

IAnimationObject

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

For examples and further explanation of the UI drawing concepts represented by Brush, see Use brushes.

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. 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.

Brush derived classes

Brush is the parent class for several derived classes that either implement practical brushes that paint UI regions, or are intermediate base classes for such brushes:

• GradientBrush: Intermediate base class for LinearGradientBrush.
• SolidColorBrush: This is by far the most commonly used Brush.
• TileBrush: Intermediate base class for ImageBrush.

Version history

Windows version	SDK version	Value added
1809	17763	PopulatePropertyInfo
1809	17763	PopulatePropertyInfoOverride

Constructors

Brush()

Provides base class initialization behavior for Brush-derived classes.

Properties

Dispatcher	Gets the CoreDispatcher that this object is associated with. The CoreDispatcher 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)
Opacity	Gets or sets the degree of opacity of a Brush.
OpacityProperty	Identifies the Opacity dependency property.
RelativeTransform	Gets or sets the transformation that is applied to the brush using relative coordinates.
RelativeTransformProperty	Identifies the RelativeTransform dependency property.
Transform	Gets or sets the transformation that is applied to the brush.
TransformProperty	Identifies the Transform dependency property.

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.
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)	When overridden in a derived class, defines a property that can be animated.
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)

See also

• DependencyObject
• SolidColorBrush
• Color
• Colors
• Use brushes
• Image and ImageBrush
• ResourceDictionary and XAML resource references