Skip to main content

DirectProperty<TOwner, TValue> Class

A direct avalonia property.

Definition

Namespace: Avalonia
Assembly: Avalonia.Base (in Avalonia.Base.dll)

public class DirectProperty<TOwner, TValue> : DirectPropertyBase<TValue>
where TOwner : AvaloniaObject

View Source
InheritanceObjectAvaloniaPropertyAvaloniaProperty(TValue) → DirectPropertyBase(TValue) → DirectProperty(TOwner, TValue)

Type Parameters

The class that registered the property.
The type of the property's value.

Remarks

Direct avalonia properties are backed by a field on the object, but exposed via the AvaloniaProperty system. They hold a getter and an optional setter which allows the avalonia property system to read and write the current value.

Properties

ChangedGets an observable that is fired when this property changes on any AvaloniaObject instance.
(Inherited from AvaloniaProperty(TValue))
GetterGets the getter function.
InheritsGets a value indicating whether the property inherits its value.
(Inherited from AvaloniaProperty)
IsAttachedGets a value indicating whether this is an attached property.
(Inherited from AvaloniaProperty)
IsDirectGets a value indicating whether this is a direct property.
(Inherited from AvaloniaProperty)
IsReadOnlyGets a value indicating whether this is a readonly property.
(Inherited from AvaloniaProperty)
NameGets the name of the property.
(Inherited from AvaloniaProperty)
OwnerGets the type that registered the property.
(Inherited from DirectPropertyBase(TValue))
OwnerTypeGets the type of the class that registered the property.
(Inherited from AvaloniaProperty)
PropertyTypeGets the type of the property's value.
(Inherited from AvaloniaProperty)
SetterGets the setter function.

Methods

AddOwner(TNewOwner)(Func(TNewOwner, TValue), Action(TNewOwner, TValue), TValue, BindingMode, Boolean)Registers the direct property on another type.
Bind()Returns a binding accessor that can be passed to AvaloniaObject's [] operator to initiate a binding.
(Inherited from AvaloniaProperty)
Equals(AvaloniaProperty)Indicates whether the current object is equal to another object of the same type.
(Inherited from AvaloniaProperty)
Equals(Object)Determines whether the specified object is equal to the current object.
(Inherited from AvaloniaProperty)
Finalize()Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCode()Serves as the default hash function.
(Inherited from AvaloniaProperty)
GetMetadata(AvaloniaObject)Gets the AvaloniaPropertyMetadata which applies to this property when it is used with the specified object.
(Inherited from DirectPropertyBase(TValue))
GetMetadata(Type)Gets the AvaloniaPropertyMetadata which applies to this property when it is used with the specified type.
(Inherited from DirectPropertyBase(TValue))
GetMetadata(T)()Gets the AvaloniaPropertyMetadata which applies to this property when it is used with the specified type.
(Inherited from AvaloniaProperty)
GetType()Gets the Type of the current instance.
(Inherited from Object)
GetUnsetValue(AvaloniaObject)Gets the unset value for the property on the specified object.
(Inherited from DirectPropertyBase(TValue))
GetUnsetValue(Type)Gets the unset value for the property on the specified type.
(Inherited from DirectPropertyBase(TValue))
IsValidValue(Object)Checks whether the value is valid for the property.
(Inherited from AvaloniaProperty)
MemberwiseClone()Creates a shallow copy of the current Object.
(Inherited from Object)
OverrideMetadata(Type, DirectPropertyMetadata(TValue))Overrides the metadata for the property on the specified type.
(Inherited from DirectPropertyBase(TValue))
OverrideMetadata(T)(DirectPropertyMetadata(TValue))Overrides the metadata for the property on the specified type.
(Inherited from DirectPropertyBase(TValue))
ToString()Gets the string representation of the property.
(Inherited from AvaloniaProperty)
Unregister(Type)
(Inherited from AvaloniaProperty)

See Also

Reference

Avalonia Namespace