Skip to main content
Brush Class
 

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

Namespace:   System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)

SystemObject
   System.Windows.ThreadingDispatcherObject
     System.WindowsDependencyObject
       System.WindowsFreezable
         System.Windows.Media.AnimationAnimatable
          System.Windows.MediaBrush
             System.Windows.MediaBitmapCacheBrush
             System.Windows.MediaGradientBrush
             System.Windows.MediaSolidColorBrush
             System.Windows.MediaTileBrush

[LocalizabilityAttribute(LocalizationCategory.None, Readability = Readability.Unreadable)]
[TypeConverterAttribute(typeof(BrushConverter))]
public abstract class Brush : Animatable, IFormattable
[LocalizabilityAttribute(LocalizationCategory::None, Readability = Readability::Unreadable)]
[TypeConverterAttribute((BrushConverter^::typeid))]
public ref class Brush abstract : Animatable, IFormattable
[<AbstractClass>]
[<LocalizabilityAttribute(LocalizationCategory.None, Readability = Readability.Unreadable)>]
[<TypeConverterAttribute(typeof(BrushConverter))>]
type Brush = 
    class
        inherit Animatable
        interface IFormattable
    end
<LocalizabilityAttribute(LocalizationCategory.None, Readability := Readability.Unreadable)>
<TypeConverterAttribute(GetType(BrushConverter))>
Public MustInherit Class Brush
	Inherits Animatable
	Implements IFormattable
NameDescription
System_CAPS_protmethod Brush

Initializes a new instance of the Brush class.

NameDescription
System_CAPS_pubproperty

Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)

System_CAPS_pubproperty

Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)

System_CAPS_pubproperty

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubproperty

Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.)

System_CAPS_pubproperty

Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)

System_CAPS_pubproperty

Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)

System_CAPS_pubproperty

Gets or sets the degree of opacity of a Brush.

System_CAPS_pubproperty

Gets or sets the transformation that is applied to the brush using relative coordinates.

System_CAPS_pubproperty

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.

NameDescription
System_CAPS_pubmethod ApplyAnimationClock

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)

System_CAPS_pubmethod ApplyAnimationClock

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.)

System_CAPS_pubmethod BeginAnimation

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

System_CAPS_pubmethod BeginAnimation

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

System_CAPS_pubmethod CheckAccess

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethod ClearValue

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethod ClearValue

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)

System_CAPS_pubmethod Clone

Creates a modifiable clone of this Brush, 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.

System_CAPS_protmethod CloneCore

Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)

System_CAPS_pubmethod CloneCurrentValue

Creates a modifiable clone of this Brush object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.

System_CAPS_protmethod CloneCurrentValueCore

Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values.(Inherited from Freezable.)

System_CAPS_pubmethod CoerceValue

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

System_CAPS_protmethod CreateInstance

Initializes a new instance of the Freezable class. (Inherited from Freezable.)

System_CAPS_protmethod CreateInstanceCore

When implemented in a derived class, creates a new instance of the Freezable derived class. (Inherited from Freezable.)

System_CAPS_pubmethod Equals

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethod Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethod Freeze

Makes the current object unmodifiable and sets its property to true. (Inherited from Freezable.)

System_CAPS_protmethod FreezeCore

Makes this Animatable object unmodifiable or determines whether it can be made unmodifiable.(Inherited from Animatable.)

System_CAPS_pubmethod GetAnimationBaseValue

Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.)

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

System_CAPS_protmethod GetAsFrozenCore

Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values.(Inherited from Freezable.)

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

System_CAPS_protmethod GetCurrentValueAsFrozenCore

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

System_CAPS_pubmethod GetHashCode

Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethod GetLocalValueEnumerator

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod GetValue

Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethod InvalidateProperty

Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethod OnChanged

Called when the current Freezable object is modified. (Inherited from Freezable.)

System_CAPS_protmethod OnFreezablePropertyChanged

Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set.(Inherited from Freezable.)

System_CAPS_protmethod OnFreezablePropertyChanged

This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.(Inherited from Freezable.)

System_CAPS_protmethod OnPropertyChanged

Overrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable.(Inherited from Freezable.)

System_CAPS_pubmethod ReadLocalValue

Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)

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

System_CAPS_pubmethod SetCurrentValue

Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)

System_CAPS_pubmethod SetValue

Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethod SetValue

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)

System_CAPS_protmethod ShouldSerializeProperty

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)

System_CAPS_pubmethod ToString

Return string representation of this Brush. (Overrides ObjectToString.)

System_CAPS_pubmethod ToString

Creates a string representation of this object based on the specified culture-specific formatting information.

System_CAPS_pubmethod VerifyAccess

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

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

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

NameDescription
System_CAPS_pubfield System_CAPS_static OpacityProperty

Identifies the  dependency property.

System_CAPS_pubfield System_CAPS_static RelativeTransformProperty

Identifies the  dependency property.

System_CAPS_pubfield System_CAPS_static TransformProperty

Identifies the  dependency property.

NameDescription
System_CAPS_pubevent Changed

Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod IFormattableToString

Formats the value of the current instance using the specified format.

A Brush "paints" or "fills" an area with its output. Different brushes have different types of output. Some brushes paint an area with a solid color, others with a gradient, pattern, image, or drawing. The following list describes the different types of WPF brushes:

Use the Brushes class to paint an object using a predefined solid color, such as or .

The following table lists the different Brush types that can be used in XAML and the syntax they support. For detailed syntax information for a specific brush, see that brush's type page.

Class

Attribute Syntax

Object Element Syntax

SolidColorBrush

Yes

Yes

DrawingBrush

No

Yes

ImageBrush

No

Yes

LinearGradientBrush

No

Yes

RadialGradientBrush

No

Yes

VisualBrush

No

Yes

For an example showing how to quickly paint an area with a solid color, see How to: Paint an Area with a Solid Color.

A brush is a type of Freezable object. For information about Freezable features, such as freezing and cloning, see the Freezable Objects Overview.

For XAML information, see the Remarks section.

Notes to Inheritors:

When you inherit from the Brush class, you must override the CreateInstanceCore method. Depending on whether your class must perform additional initialization work or contains non-dependency property data members, you might need to override additional Freezable methods. For more information about inheriting from Freezable types, see the Freezable Objects Overview.

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top