StyledPropertyBase<TValue> Class

Summary

Base class for styled properties.
Namespace
Avalonia
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["AvaloniaProperty<TValue>"] Base0-->Base1["AvaloniaProperty"] click Base1 "/api/Avalonia/AvaloniaProperty" Base1-->Base2["object"] Type-.->Interface0["IEquatable<AvaloniaProperty>"] Type-.->Interface1["IPropertyInfo"] click Interface1 "/api/Avalonia.Data.Core/IPropertyInfo" Type-.->Interface2["IStyledPropertyAccessor"] Type["StyledPropertyBase<TValue>"] class Type type-node Derived0["StyledProperty<TValue>"]-->Type click Derived0 "/api/Avalonia/StyledProperty_1"

Syntax

public abstract class StyledPropertyBase<TValue> : AvaloniaProperty<TValue>, 
    IEquatable<AvaloniaProperty>, IPropertyInfo, IStyledPropertyAccessor

Type Parameters

Name Description
TValue

Constructors

Name Summary
StyledPropertyBase(string, Type, StyledPropertyMetadata<TValue>, bool, Func<TValue, bool>, Action<IAvaloniaObject, bool>) Initializes a new instance of the StyledPropertyBase<TValue> class.
StyledPropertyBase(StyledPropertyBase<TValue>, Type) Initializes a new instance of the StyledPropertyBase<TValue> class.

Fields

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

Properties

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

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.
Inherited from AvaloniaProperty
CoerceValue(IAvaloniaObject, TValue) TValue
Equals(AvaloniaProperty) bool
Inherited from AvaloniaProperty
Equals(object) bool
Inherited from AvaloniaProperty
GetDefaultValue(Type) TValue
Gets the default value for the property on the specified type.
GetHashCode() int
Inherited from AvaloniaProperty
GetMetadata(Type) StyledPropertyMetadata<TValue>
Gets the property metadata for the specified type.
GetMetadata(Type) AvaloniaPropertyMetadata
Gets the property metadata for the specified type.
Inherited from AvaloniaProperty
GetMetadata<T>() AvaloniaPropertyMetadata
Gets the property metadata for the specified type.
Inherited from AvaloniaProperty
IsValidValue(object) bool
Checks whether the value is valid for the property.
Inherited from AvaloniaProperty
OverrideDefaultValue(Type, TValue) void
Overrides the default value for the property on the specified type.
OverrideDefaultValue<T>(TValue) void
Overrides the default value for the property on the specified type.
OverrideMetadata(Type, AvaloniaPropertyMetadata) void
Overrides the metadata for the property on the specified type.
Inherited from AvaloniaProperty
OverrideMetadata(Type, StyledPropertyMetadata<TValue>) void
Overrides the metadata for the property on the specified type.
OverrideMetadata<T>(StyledPropertyMetadata<TValue>) 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.
Inherited from AvaloniaProperty
static
RegisterAttached<THost, TValue>(string, Type, TValue, bool, BindingMode, Func<TValue, bool>, Func<IAvaloniaObject, TValue, TValue>) AttachedProperty<TValue>
Registers an attached AvaloniaProperty.
Inherited from AvaloniaProperty
static
RegisterAttached<TOwner, THost, TValue>(string, TValue, bool, BindingMode, Func<TValue, bool>, Func<IAvaloniaObject, TValue, TValue>) AttachedProperty<TValue>
Registers an attached AvaloniaProperty.
Inherited from AvaloniaProperty
static
RegisterDirect<TOwner, TValue>(string, Func<TOwner, TValue>, Action<TOwner, TValue>, TValue, BindingMode, bool) DirectProperty<TOwner, TValue>
Registers a direct AvaloniaProperty.
Inherited from AvaloniaProperty
static
ToString() string
Gets the string representation of the property.

Operators

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

Extension Methods

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