Avalonia API Reference
Template
A XAML binding to a property on a control's templated parent.
Definition
Namespace: Avalonia.Data
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 TemplateBinding : UntypedBindingExpressionBase,
IBinding, IDescription, ISetterValue, IDisposable, IObserver<Object>,
IObservable<Object>VB
Public Class TemplateBinding
Inherits UntypedBindingExpressionBase
Implements IBinding, IDescription, ISetterValue, IDisposable,
IObserver(Of Object), IObservable(Of Object)F#
type TemplateBinding =
class
inherit UntypedBindingExpressionBase
interface IBinding
interface IDescription
interface ISetterValue
interface IDisposable
interface IObserver<Object>
interface IObservable<Object>
end- Inheritance
- Object BindingExpressionBase UntypedBindingExpressionBase TemplateBinding
- Implements
- IBinding, IDescription, ISetterValue, IDisposable, IObservableObject, IObserverObject
Properties
| Converter | Gets or sets the IValueConverter to use. |
| ConverterCulture | Gets or sets the culture in which to evaluate the converter. |
| ConverterParameter | Gets or sets a parameter to pass to Converter. |
| Description |
Gets a description of the binding expression.
(Overrides UntypedBindingExpressionBaseDescription) |
| ErrorType |
Gets the current error state of the binding expression.
(Inherited from UntypedBindingExpressionBase) |
| IsDataValidationEnabled |
Gets a value indicating whether data validation is enabled for the binding expression.
(Inherited from UntypedBindingExpressionBase) |
| IsRunning |
Gets a value indicating whether the binding expression is currently running.
(Inherited from UntypedBindingExpressionBase) |
| Mode | Gets or sets the binding mode. |
| Priority |
Gets the priority of the binding expression.
(Inherited from UntypedBindingExpressionBase) |
| Property | Gets or sets the name of the source property on the templated parent. |
| TargetProperty |
Gets the AvaloniaProperty which the binding expression is targeting.
(Inherited from UntypedBindingExpressionBase) |
| TargetType |
Gets the target type of the binding expression; that is, the type that values produced by
the expression should be converted to.
(Inherited from UntypedBindingExpressionBase) |
Methods
| ConvertBack(IValueConverter, CultureInfo, Object, Object, Type) |
Converts a value using a value converter's ConvertBack method, logging a warning if
necessary.
(Inherited from UntypedBindingExpressionBase) |
| Dispose |
Terminates the binding.
(Inherited from UntypedBindingExpressionBase) |
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| 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 Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValue |
Gets the current value of the binding expression.
(Inherited from UntypedBindingExpressionBase) |
| GetValueOrDefault |
Gets the current value of the binding expression or the default value for the target property.
(Inherited from UntypedBindingExpressionBase) |
| Initiate(AvaloniaObject, AvaloniaProperty, Object, Boolean) | |
| Log(String, LogEventLevel) |
Logs a binding error.
(Inherited from UntypedBindingExpressionBase) |
| Log(AvaloniaObject, String, LogEventLevel) |
Logs a binding error.
(Inherited from UntypedBindingExpressionBase) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ProvideValue | |
| ShouldLogError(AvaloniaObject) |
Gets a value indicating whether an error should be logged given the current state of the
binding expression.
(Inherited from UntypedBindingExpressionBase) |
| Start |
Starts the binding expression following a call to AttachCore(IBindingExpressionSink, ImmediateValueFrame, AvaloniaObject, AvaloniaProperty, BindingPriority).
(Inherited from UntypedBindingExpressionBase) |
| Start(Boolean) |
Starts the binding expression by calling StartCore.
(Inherited from UntypedBindingExpressionBase) |
| StartCore | (Overrides UntypedBindingExpressionBaseStartCore) |
| Stop |
Stops the binding expression by calling StopCore.
(Inherited from UntypedBindingExpressionBase) |
| StopCore | (Overrides UntypedBindingExpressionBaseStopCore) |
| Subscribe(IObserverObject) | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetTarget(AvaloniaObject) |
Tries to retrieve the target for the binding expression.
(Inherited from UntypedBindingExpressionBase) |
| UpdateSource |
Sends the current binding target value to the binding source property in
TwoWay or OneWayToSource bindings.
(Inherited from BindingExpressionBase) |
| UpdateTarget |
Forces a data transfer from the binding source to the binding target.
(Inherited from BindingExpressionBase) |
Extension Methods
| StreamBindingObject | (Defined by StreamBindingExtensions) |
| ToBindingObject |
Converts an IObservableT to an IBinding.
(Defined by AvaloniaObjectExtensions) |