Brush Class

Summary

Describes how an area is painted.
graph BT Type-->Base0["Animatable"] click Base0 "/api/Avalonia.Animation/Animatable" Base0-->Base1["AvaloniaObject"] click Base1 "/api/Avalonia/AvaloniaObject" Base1-->Base2["object"] Type-.->Interface0["IAvaloniaObject"] click Interface0 "/api/Avalonia/IAvaloniaObject" Type-.->Interface1["IAvaloniaObjectDebug"] click Interface1 "/api/Avalonia.Diagnostics/IAvaloniaObjectDebug" Type-.->Interface2["INotifyPropertyChanged"] Type-.->Interface3["IMutableBrush"] click Interface3 "/api/Avalonia.Media/IMutableBrush" Type-.->Interface4["IBrush"] click Interface4 "/api/Avalonia.Media/IBrush" Type-.->Interface5["IAffectsRender"] click Interface5 "/api/Avalonia.Media/IAffectsRender" Type["Brush"] class Type type-node Derived0["SolidColorBrush"]-->Type click Derived0 "/api/Avalonia.Media/SolidColorBrush" Derived1["TileBrush"]-->Type click Derived1 "/api/Avalonia.Media/TileBrush" Derived2["GradientBrush"]-->Type click Derived2 "/api/Avalonia.Media/GradientBrush"

Syntax

[TypeConverter(typeof(BrushConverter))]
public abstract class Brush : Animatable, IAvaloniaObject, IAvaloniaObjectDebug, 
    INotifyPropertyChanged, IMutableBrush, IBrush, IAffectsRender

Attributes

Type Description
TypeConverter

Events

Name Type Summary
Invalidated EventHandler
Raised when the resource changes visually.
PropertyChanged EventHandler<AvaloniaPropertyChangedEventArgs>
Raised when a AvaloniaProperty value changes on this object.
Inherited from AvaloniaObject

Fields

Name Constant Value Summary
ClockProperty
Inherited from Animatable
static
OpacityProperty
Defines the Opacity property.
static
TransitionsProperty
Defines the Transitions property.
Inherited from Animatable
static

Properties

Name Value Summary
Clock IClock
Inherited from Animatable
InheritanceParent IAvaloniaObject
Gets or sets the parent object that inherited AvaloniaProperty values are inherited from.
Inherited from AvaloniaObject
Opacity double
Gets or sets the opacity of the brush.
this[AvaloniaProperty] object
Gets or sets the value of a AvaloniaProperty.
Inherited from AvaloniaObject
this[IndexerDescriptor] IBinding
Gets or sets a binding for a AvaloniaProperty.
Inherited from AvaloniaObject
Transitions Transitions
Gets or sets the property transitions for the control.
Inherited from Animatable

Methods

Name Value Summary
AffectsRender<T>(AvaloniaProperty[]) void
Marks a property as affecting the brush's visual representation.
static
AffectsValidation(AvaloniaProperty, AvaloniaProperty[]) void
Forces revalidation of properties when a property value changes.
Inherited from AvaloniaObject
static
Bind(AvaloniaProperty, IObservable<object>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
Inherited from AvaloniaObject
Bind<T>(AvaloniaProperty<T>, IObservable<T>, BindingPriority) IDisposable
Binds a AvaloniaProperty to an observable.
Inherited from AvaloniaObject
CheckAccess() bool
Inherited from AvaloniaObject
ClearValue(AvaloniaProperty) void
Clears a AvaloniaProperty's local value.
Inherited from AvaloniaObject
Equals(object) bool
Compares two objects using reference equality.
Inherited from AvaloniaObject
GetHashCode() int
Gets the hash code for the object.
Inherited from AvaloniaObject
GetValue(AvaloniaProperty) object
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
GetValue<T>(AvaloniaProperty<T>) T
Gets a AvaloniaProperty value.
Inherited from AvaloniaObject
IsAnimating(AvaloniaProperty) bool
Checks whether a AvaloniaProperty is animating.
Inherited from AvaloniaObject
IsSet(AvaloniaProperty) bool
Checks whether a AvaloniaProperty is set on this object.
Inherited from AvaloniaObject
OnPropertyChanged(AvaloniaPropertyChangedEventArgs) void
Reacts to a change in a AvaloniaProperty value in order to animate the change if a ITransition is set for the property.
Inherited from Animatable
Parse(string) IBrush
Parses a brush string.
static
RaiseInvalidated(EventArgs) void
Raises the Invalidated event.
Revalidate(AvaloniaProperty) void
Forces the specified property to be revalidated.
Inherited from AvaloniaObject
SetAndRaise<T>(AvaloniaProperty<T>, T, T) bool
Sets the backing field for a direct avalonia property, raising the PropertyChanged event if the value has changed.
Inherited from AvaloniaObject
SetValue(AvaloniaProperty, object, BindingPriority) void
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
SetValue<T>(AvaloniaProperty<T>, T, BindingPriority) void
Sets a AvaloniaProperty value.
Inherited from AvaloniaObject
ToImmutable() IBrush
Creates an immutable clone of the brush.
UpdateDataValidation(AvaloniaProperty, BindingNotification) void
Called to update the validation state for properties for which data validation is enabled.
Inherited from AvaloniaObject
VerifyAccess() void
Inherited from AvaloniaObject

Extension Methods