AvaloniaProperty Class

Summary

Base class for avalonia properties.
Namespace
Avalonia
Interfaces
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type-.->Interface0["IEquatable<AvaloniaProperty>"] Type-.->Interface1["IPropertyInfo"] click Interface1 "/api/Avalonia.Data.Core/IPropertyInfo" Type["AvaloniaProperty"] class Type type-node Derived0["AvaloniaProperty<TValue>"]-->Type click Derived0 "/api/Avalonia/AvaloniaProperty_1"

Syntax

public abstract class AvaloniaProperty : IEquatable<AvaloniaProperty>, IPropertyInfo

Constructors

Name Summary
AvaloniaProperty(AvaloniaProperty, Type, AvaloniaPropertyMetadata) Initializes a new instance of the AvaloniaProperty class.
AvaloniaProperty(string, Type, Type, AvaloniaPropertyMetadata, Action<IAvaloniaObject, bool>) Initializes a new instance of the AvaloniaProperty class.

Fields

Name Constant Value Summary
UnsetValue
Represents an unset property value.
static

Properties

Name Value Summary
Changed IObservable<AvaloniaPropertyChangedEventArgs>
Gets an observable that is fired when this property changes on any AvaloniaObject instance.
Inherits bool
Gets a value indicating whether the property inherits its value.
IsAttached bool
Gets a value indicating whether this is an attached property.
IsDirect bool
Gets a value indicating whether this is a direct property.
IsReadOnly bool
Gets a value indicating whether this is a readonly property.
Name string
Gets the name of the property.
Notifying Action<IAvaloniaObject, bool>
Gets a method that gets called before and after the property starts being notified on an object.
OwnerType Type
Gets the type of the class that registered the property.
PropertyType Type
Gets the type of the property's value.

Methods

Name Value Summary
Accept<TData>(IAvaloniaPropertyVisitor<TData>, TData) void
Uses the visitor pattern to resolve an untyped property to a typed property.
Bind() IndexerDescriptor
Returns a binding accessor that can be passed to AvaloniaObject's [] operator to initiate a binding.
Equals(AvaloniaProperty) bool
Equals(object) bool
GetChanged() IObservable<AvaloniaPropertyChangedEventArgs>
GetHashCode() int
GetMetadata(Type) AvaloniaPropertyMetadata
Gets the property metadata for the specified type.
GetMetadata<T>() AvaloniaPropertyMetadata
Gets the property metadata for the specified type.
IsValidValue(object) bool
Checks whether the value is valid for the property.
OverrideMetadata(Type, AvaloniaPropertyMetadata) void
Overrides the metadata for the property on the specified type.
Register<TOwner, TValue>(string, TValue, bool, BindingMode, Func<TValue, bool>, Func<IAvaloniaObject, TValue, TValue>, Action<IAvaloniaObject, bool>) StyledProperty<TValue>
Registers a AvaloniaProperty.
static
RegisterAttached<THost, TValue>(string, Type, TValue, bool, BindingMode, Func<TValue, bool>, Func<IAvaloniaObject, TValue, TValue>) AttachedProperty<TValue>
Registers an attached AvaloniaProperty.
static
RegisterAttached<TOwner, THost, TValue>(string, TValue, bool, BindingMode, Func<TValue, bool>, Func<IAvaloniaObject, TValue, TValue>) AttachedProperty<TValue>
Registers an attached AvaloniaProperty.
static
RegisterDirect<TOwner, TValue>(string, Func<TOwner, TValue>, Action<TOwner, TValue>, TValue, BindingMode, bool) DirectProperty<TOwner, TValue>
Registers a direct AvaloniaProperty.
static
ToString() string
Gets the string representation of the property.

Operators

Name Value Summary
operator !(AvaloniaProperty) IndexerDescriptor
operator !=(AvaloniaProperty, AvaloniaProperty) bool
operator ~(AvaloniaProperty) IndexerDescriptor
operator ==(AvaloniaProperty, AvaloniaProperty) bool

Extension Methods

Name Value Summary
CanValueAffectRender() bool
Checks if values of given property can affect rendering (via IAffectsRender).