Avalonia API Reference
Direct
A direct avalonia property.
Definition
Namespace: Avalonia
Assembly: Avalonia.Base (in Avalonia.Base.dll) Version: 11.3.999
Assembly: Avalonia.Base (in Avalonia.Base.dll) Version: 11.3.999
C#
public class DirectProperty<TOwner, TValue> : DirectPropertyBase<TValue>
where TOwner : AvaloniaObject
VB
Public Class DirectProperty(Of TOwner As AvaloniaObject, TValue)
Inherits DirectPropertyBase(Of TValue)F#
type DirectProperty<'TOwner, 'TValue when 'TOwner : AvaloniaObject> =
class
inherit DirectPropertyBase<'TValue>
end- Inheritance
- Object AvaloniaProperty AvaloniaPropertyTValue DirectPropertyBaseTValue DirectPropertyTOwner, TValue
Type Parameters
- TOwner
- The class that registered the property.
- TValue
- 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
| Changed |
Gets an observable that is fired when this property changes on any
AvaloniaObject instance.
(Inherited from AvaloniaPropertyTValue) |
| Getter | Gets the getter function. |
| Inherits |
Gets a value indicating whether the property inherits its value.
(Inherited from AvaloniaProperty) |
| IsAttached |
Gets a value indicating whether this is an attached property.
(Inherited from AvaloniaProperty) |
| IsDirect |
Gets a value indicating whether this is a direct property.
(Inherited from AvaloniaProperty) |
| IsReadOnly |
Gets a value indicating whether this is a readonly property.
(Inherited from AvaloniaProperty) |
| Name |
Gets the name of the property.
(Inherited from AvaloniaProperty) |
| Owner |
Gets the type that registered the property.
(Inherited from DirectPropertyBaseTValue) |
| OwnerType |
Gets the type of the class that registered the property.
(Inherited from AvaloniaProperty) |
| PropertyType |
Gets the type of the property's value.
(Inherited from AvaloniaProperty) |
| Setter | Gets the setter function. |
Methods
| AddOwnerTNewOwner(FuncTNewOwner, TValue, ActionTNewOwner, 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 DirectPropertyBaseTValue) |
| GetMetadata(Type) |
Gets the AvaloniaPropertyMetadata which applies to this property when it is used with the specified type.
(Inherited from DirectPropertyBaseTValue) |
| GetMetadataT |
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 DirectPropertyBaseTValue) |
| GetUnsetValue(Type) |
Gets the unset value for the property on the specified type.
(Inherited from DirectPropertyBaseTValue) |
| 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, DirectPropertyMetadataTValue) |
Overrides the metadata for the property on the specified type.
(Inherited from DirectPropertyBaseTValue) |
| OverrideMetadataT(DirectPropertyMetadataTValue) |
Overrides the metadata for the property on the specified type.
(Inherited from DirectPropertyBaseTValue) |
| ToString |
Gets the string representation of the property.
(Inherited from AvaloniaProperty) |
| Unregister(Type) | (Inherited from AvaloniaProperty) |