AvaloniaObjectExtensions Class

Definition

Namespace:Avalonia

Assembly:Avalonia.Base

Package:Avalonia

Source:AvaloniaObjectExtensions.cs

Provides extension methods for Avalonia.AvaloniaObject and related classes.

public class AvaloniaObjectExtensions

Inheritance: object -> AvaloniaObjectExtensions

Methods

Name	Description
AddClassHandler (2 overloads)	No summary available.
Bind (2 overloads)	No summary available.
GetBaseValue (2 overloads)	Gets an Avalonia.AvaloniaProperty base value.
GetBindingObservable (4 overloads)	Gets an observable for an Avalonia.AvaloniaProperty.
GetObservable (4 overloads)	Gets an observable for an Avalonia.AvaloniaProperty.
GetPropertyChangedObservable	Gets an observable that listens for property changed events for an Avalonia.AvaloniaProperty.
GetValue	No summary available.
ToBinding	No summary available.

AddClassHandler overloads

AddClassHandler Method

public IDisposable AddClassHandler<TTarget>(IObservable<Avalonia.AvaloniaPropertyChangedEventArgs> observable, Action<TTarget, Avalonia.AvaloniaPropertyChangedEventArgs> action)

Parameters

observable IObservable<Avalonia.AvaloniaPropertyChangedEventArgs>

action Action<TTarget, Avalonia.AvaloniaPropertyChangedEventArgs>

Type Parameters

TTarget

Returns

IDisposable

AddClassHandler Method

public IDisposable AddClassHandler<TTarget, TValue>(IObservable<Avalonia.AvaloniaPropertyChangedEventArgs<T><TValue>> observable, Action<TTarget, Avalonia.AvaloniaPropertyChangedEventArgs<T><TValue>> action)

Parameters

observable IObservable<Avalonia.AvaloniaPropertyChangedEventArgs<T><TValue>>

action Action<TTarget, Avalonia.AvaloniaPropertyChangedEventArgs<T><TValue>>

Type Parameters

TTarget

TValue

Returns

IDisposable

Bind overloads

Bind Method

public IDisposable Bind<T>(Avalonia.AvaloniaObject target, Avalonia.AvaloniaProperty<TValue><T> property, IObservable<Avalonia.Data.BindingValue<T><T>> source, Avalonia.Data.BindingPriority priority)

Parameters

target Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty<TValue><T>

source IObservable<Avalonia.Data.BindingValue<T><T>>

priority Avalonia.Data.BindingPriority

Type Parameters

T

Returns

IDisposable

Bind Method

public IDisposable Bind<T>(Avalonia.AvaloniaObject target, Avalonia.AvaloniaProperty<TValue><T> property, IObservable<T> source, Avalonia.Data.BindingPriority priority)

Parameters

target Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty<TValue><T>

source IObservable<T>

priority Avalonia.Data.BindingPriority

Type Parameters

T

Returns

IDisposable

GetBaseValue overloads

GetBaseValue Method

Gets an Avalonia.AvaloniaProperty base value.

public object GetBaseValue(Avalonia.AvaloniaObject target, Avalonia.AvaloniaProperty property)

Parameters

target Avalonia.AvaloniaObject

The object.

property Avalonia.AvaloniaProperty

The property.

Returns

object

Remarks

For styled properties, gets the value of the property excluding animated values, otherwise Avalonia.AvaloniaProperty.UnsetValue. Note that this method does not return property values that come from inherited or default values.

For direct properties returns the current value of the property.

GetBaseValue Method

public Avalonia.Data.Optional<T><T> GetBaseValue<T>(Avalonia.AvaloniaObject target, Avalonia.AvaloniaProperty<TValue><T> property)

Parameters

target Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty<TValue><T>

Type Parameters

T

Returns

Avalonia.Data.Optional<T><T>

GetBindingObservable overloads

GetBindingObservable Method

Gets an observable for an Avalonia.AvaloniaProperty.

public IObservable<Avalonia.Data.BindingValue<T><object>> GetBindingObservable(Avalonia.AvaloniaObject o, Avalonia.AvaloniaProperty property)

Parameters

o Avalonia.AvaloniaObject

The object.

property Avalonia.AvaloniaProperty

The property.

Returns

IObservable<Avalonia.Data.BindingValue<T><object>>

An observable which fires immediately with the current value of the property on the object and subsequently each time the property value changes.

Remarks

The subscription to o is created using a weak reference.

GetBindingObservable Method

public IObservable<Avalonia.Data.BindingValue<T><TResult>> GetBindingObservable<TResult>(Avalonia.AvaloniaObject o, Avalonia.AvaloniaProperty property, Func<object, TResult> converter)

Parameters

o Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty

converter Func<object, TResult>

Type Parameters

TResult

Returns

IObservable<Avalonia.Data.BindingValue<T><TResult>>

GetBindingObservable Method

public IObservable<Avalonia.Data.BindingValue<T><T>> GetBindingObservable<T>(Avalonia.AvaloniaObject o, Avalonia.AvaloniaProperty<TValue><T> property)

Parameters

o Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty<TValue><T>

Type Parameters

T

Returns

IObservable<Avalonia.Data.BindingValue<T><T>>

GetBindingObservable Method

public IObservable<Avalonia.Data.BindingValue<T><TResult>> GetBindingObservable<TSource, TResult>(Avalonia.AvaloniaObject o, Avalonia.AvaloniaProperty<TValue><TSource> property, Func<TSource, TResult> converter)

Parameters

o Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty<TValue><TSource>

converter Func<TSource, TResult>

Type Parameters

TSource

TResult

Returns

IObservable<Avalonia.Data.BindingValue<T><TResult>>

GetObservable overloads

GetObservable Method

Gets an observable for an Avalonia.AvaloniaProperty.

public IObservable<object> GetObservable(Avalonia.AvaloniaObject o, Avalonia.AvaloniaProperty property)

Parameters

o Avalonia.AvaloniaObject

The object.

property Avalonia.AvaloniaProperty

The property.

Returns

IObservable<object>

An observable which fires immediately with the current value of the property on the object and subsequently each time the property value changes.

Remarks

The subscription to o is created using a weak reference.

GetObservable Method

public IObservable<TResult> GetObservable<TResult>(Avalonia.AvaloniaObject o, Avalonia.AvaloniaProperty property, Func<object, TResult> converter)

Parameters

o Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty

converter Func<object, TResult>

Type Parameters

TResult

Returns

IObservable<TResult>

GetObservable Method

public IObservable<T> GetObservable<T>(Avalonia.AvaloniaObject o, Avalonia.AvaloniaProperty<TValue><T> property)

Parameters

o Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty<TValue><T>

Type Parameters

T

Returns

IObservable<T>

GetObservable Method

public IObservable<TResult> GetObservable<TSource, TResult>(Avalonia.AvaloniaObject o, Avalonia.AvaloniaProperty<TValue><TSource> property, Func<TSource, TResult> converter)

Parameters

o Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty<TValue><TSource>

converter Func<TSource, TResult>

Type Parameters

TSource

TResult

Returns

IObservable<TResult>

GetPropertyChangedObservable Method

Gets an observable that listens for property changed events for an Avalonia.AvaloniaProperty.

public IObservable<Avalonia.AvaloniaPropertyChangedEventArgs> GetPropertyChangedObservable(Avalonia.AvaloniaObject o, Avalonia.AvaloniaProperty property)

Parameters

o Avalonia.AvaloniaObject

The object.

property Avalonia.AvaloniaProperty

The property.

Returns

IObservable<Avalonia.AvaloniaPropertyChangedEventArgs>

An observable which when subscribed pushes the property changed event args each time a Avalonia.AvaloniaObject.PropertyChanged event is raised for the specified property.

GetValue Method

public T GetValue<T>(Avalonia.AvaloniaObject target, Avalonia.AvaloniaProperty<TValue><T> property)

Parameters

target Avalonia.AvaloniaObject

property Avalonia.AvaloniaProperty<TValue><T>

Type Parameters

T

Returns

T

ToBinding Method

public Avalonia.Data.BindingBase ToBinding<T>(IObservable<T> source)

Parameters

source IObservable<T>

Type Parameters

T

Returns

Avalonia.Data.BindingBase