BindableObjectExtensions.SetBinding 方法
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
重载
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)
- Source:
- BindableObjectExtensions.cs
- Source:
- BindableObjectExtensions.cs
创建绑定并将其应用到属性。
public static void SetBinding (this Microsoft.Maui.Controls.BindableObject self, Microsoft.Maui.Controls.BindableProperty targetProperty, string path, Microsoft.Maui.Controls.BindingMode mode = Microsoft.Maui.Controls.BindingMode.Default, Microsoft.Maui.Controls.IValueConverter converter = default, string stringFormat = default);static member SetBinding : Microsoft.Maui.Controls.BindableObject * Microsoft.Maui.Controls.BindableProperty * string * Microsoft.Maui.Controls.BindingMode * Microsoft.Maui.Controls.IValueConverter * string -> unit<Extension()>
Public Sub SetBinding (self As BindableObject, targetProperty As BindableProperty, path As String, Optional mode As BindingMode = Microsoft.Maui.Controls.BindingMode.Default, Optional converter As IValueConverter = Nothing, Optional stringFormat As String = Nothing)参数
- self
- BindableObject
- targetProperty
- BindableProperty
要在其上设置绑定的 BindableProperty。
- mode
- BindingMode
该绑定的 BindingMode。 此参数是可选的。 默认值为 Default。
- converter
- IValueConverter
此绑定的 IValueConverter。 此参数是可选的。 默认值为 null。
- stringFormat
- String
用作绑定的 stringFormat 的字符串。 此参数是可选的。 默认值为 null。
注解
以下示例演示如何使用扩展方法设置绑定。
public class PersonViewModel
{
public string Name { get; set; }
public string Company { get; set; }
}
// ...
var vm = new PersonViewModel {
Name = "John Doe",
Company = "Xamarin"
}
var label = new Label ();
label.SetBinding (Label.TextProperty, "Name"); // "Name" is the property on the view model
label.BindingContext = vm;
Debug.WriteLine (label.Text); // prints "John Doe"
适用于
SetBinding<TSource,TProperty>(BindableObject, BindableProperty, Func<TSource,TProperty>, BindingMode, IValueConverter, Object, String, Object, Object, Object)
- Source:
- BindableObjectExtensions.cs
在源对象上的属性和目标对象的属性之间创建绑定。
public static void SetBinding<TSource,TProperty> (this Microsoft.Maui.Controls.BindableObject self, Microsoft.Maui.Controls.BindableProperty targetProperty, Func<TSource,TProperty> getter, Microsoft.Maui.Controls.BindingMode mode = Microsoft.Maui.Controls.BindingMode.Default, Microsoft.Maui.Controls.IValueConverter? converter = default, object? converterParameter = default, string? stringFormat = default, object? source = default, object? fallbackValue = default, object? targetNullValue = default);static member SetBinding : Microsoft.Maui.Controls.BindableObject * Microsoft.Maui.Controls.BindableProperty * Func<'Source, 'Property> * Microsoft.Maui.Controls.BindingMode * Microsoft.Maui.Controls.IValueConverter * obj * string * obj * obj * obj -> unit<Extension()>
Public Sub SetBinding(Of TSource, TProperty) (self As BindableObject, targetProperty As BindableProperty, getter As Func(Of TSource, TProperty), Optional mode As BindingMode = Microsoft.Maui.Controls.BindingMode.Default, Optional converter As IValueConverter = Nothing, Optional converterParameter As Object = Nothing, Optional stringFormat As String = Nothing, Optional source As Object = Nothing, Optional fallbackValue As Object = Nothing, Optional targetNullValue As Object = Nothing)类型参数
- TSource
源类型。
- TProperty
属性类型。
参数
- self
- BindableObject
- targetProperty
- BindableProperty
要 BindableProperty 设置绑定的依据。
- getter
- Func<TSource,TProperty>
用于检索源属性的 getter 方法。
- mode
- BindingMode
绑定模式。 此属性是可选的。 默认值为 Default。
- converter
- IValueConverter
转换器。 此参数是可选的。 默认值为 null。
- converterParameter
- Object
要传递到转换器的用户定义参数。 此参数是可选的。 默认值为 null。
- stringFormat
- String
字符串格式。 此参数是可选的。 默认值为 null。
- source
- Object
用作绑定源的对象。 此参数是可选的。 默认值为 null。
- fallbackValue
- Object
如果未存在指定值，则使用的值而不是属性的默认值。
- targetNullValue
- Object
绑定目标 null为时要为绑定属性提供的值。
例外
注解
以下示例演示如何使用扩展方法设置绑定。
public class PersonViewModel
{
public string Name { get; set; }
public Address? Address { get; set; }
// ...
}
var vm = new PersonViewModel { Name = "John Doe" };
var label = new Label();
label.SetBinding(Label.TextProperty, static (PersonViewModel vm) => vm.Name);
label.BindingContext = vm;
vm.Name = "Jane Doe";
Debug.WriteLine(label.Text); // prints "Jane Doe"
并非所有方法都可用于定义绑定。 表达式必须是简单的属性访问表达式。 下面是有效和无效表达式的示例：
// Valid: Property access
static (PersonViewModel vm) => vm.Name;
static (PersonViewModel vm) => vm.Address?.Street;
// Valid: Array and indexer access
static (PersonViewModel vm) => vm.PhoneNumbers[0];
static (PersonViewModel vm) => vm.Config["Font"];
// Valid: Casts
static (Label label) => (label.BindingContext as PersonViewModel).Name;
static (Label label) => ((PersonViewModel)label.BindingContext).Name;
// Invalid: Method calls
static (PersonViewModel vm) => vm.GetAddress();
static (PersonViewModel vm) => vm.Address?.ToString();
// Invalid: Complex expressions
static (PersonViewModel vm) => vm.Address?.Street + " " + vm.Address?.City;
static (PersonViewModel vm) => $"Name: {vm.Name}";
