|
| 1 | +--- |
| 2 | +id: markupextensions |
| 3 | +title: Markup Extensions |
| 4 | +--- |
| 5 | + |
| 6 | +`Markup Extension` 允许在 XAML 中以方便、可重用的语法对目标属性的 setter 逻辑进行基于代码的自定义。大括号用于区分普通文本的使用。 |
| 7 | +Avalonia 提供了以下内容: |
| 8 | +| MarkupExtension | 分配给属性 | |
| 9 | +|--------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| |
| 10 | +| [StaticResource](/docs/guides/styles-and-resources/resources#static-resource) | 一个现有的键资源,并且不会在更改时更新 | |
| 11 | +| [DynamicResource](/docs/guides/styles-and-resources/resources#using-resources) | 延迟加载的键资源,会在更改时更新 | |
| 12 | +| Binding | 基于默认的绑定偏好:编译或反射 | |
| 13 | +| [CompiledBinding](/docs/basics/data/data-binding/compiled-bindings#compiledbinding-markup) | 基于编译的绑定 | |
| 14 | +| [ReflectionBinding](/docs/basics/data/data-binding/compiled-bindings#reflectionbinding-markup) | 基于反射的绑定 | |
| 15 | +| [TemplateBinding](/docs/guides/custom-controls/how-to-create-templated-controls#data-binding) | 基于简化的绑定,仅在 `ControlTemplate` 内使用 | |
| 16 | +| [OnPlatform](/docs/guides/platforms/platform-specific-code/xaml#onplatform-markup-extension) | 当处于指定平台时有条件地使用 | |
| 17 | +| [OnFormFactor](/docs/guides/platforms/platform-specific-code/xaml#onformfactor-markup-extension) | 当处于指定因素时有条件地使用 | |
| 18 | + |
| 19 | +## 编译器内在函数 |
| 20 | + |
| 21 | +这些技术上不属于 `MarkupExtension`,而是 XAML 编译器的一部分,但 和XAML 语法相同。 |
| 22 | + |
| 23 | +| 内在函数 | 分配给属性 | |
| 24 | +|-----------|-----------------------| |
| 25 | +| x:True | `true` 字面量 | |
| 26 | +| x:False | `false` 字面量 | |
| 27 | +| x:Null | `null` 字面量 | |
| 28 | +| x:Static | 静态成员值 | |
| 29 | +| x:Type | `System.Type` 字面量 | |
| 30 | + |
| 31 | +`x:True` 和 `x:False` 字面量在目标绑定属性为 `object` 且需要提供布尔值的情况下有用。在这些缺少类型信息的场景中,提供 "True" 仍然是一个字符串。 |
| 32 | + |
| 33 | +```xml |
| 34 | +<Button Command="{Binding SetStateCommand}" CommandParameter="{x:True}" /> |
| 35 | +``` |
| 36 | + |
| 37 | +## 创建 MarkupExtensions |
| 38 | + |
| 39 | +派生自 `MarkupExtension` 或添加以下通过鸭子类型支持的签名之一: |
| 40 | + |
| 41 | +```csharp |
| 42 | +T ProvideValue(); |
| 43 | +T ProvideValue(IServiceProvider provider); |
| 44 | +object ProvideValue(); |
| 45 | +object ProvideValue(IServiceProvider provider); |
| 46 | +``` |
| 47 | + |
| 48 | +当使用强类型而不是 `object` 时,如果在 XAML 中构造参数、属性或 `ProvideValue` 中的返回值不匹配,将会收到编译时错误。当返回 `object` 时,实际返回的类型必须与目标属性的类型匹配,否则运行时会抛出 `InvalidCastException`。 |
| 49 | + |
| 50 | +### 接收字面量参数 |
| 51 | + |
| 52 | +当需要参数时,使用构造函数按顺序接收每个参数。 |
| 53 | + |
| 54 | +对于可选或无序参数,使用属性代替。允许混合使用多个构造函数,包括无参数构造函数。 |
| 55 | + |
| 56 | +```csharp |
| 57 | +public class MultiplyLiteral |
| 58 | +{ |
| 59 | + private readonly double _first; |
| 60 | + private readonly double _second; |
| 61 | + |
| 62 | + public double? Third { get; set; } |
| 63 | + public MultiplyLiteral(double first, double second) |
| 64 | + { |
| 65 | + _first = first; |
| 66 | + _second = second; |
| 67 | + } |
| 68 | + public double ProvideValue(IServiceProvider provider) |
| 69 | + { |
| 70 | + return First * Second * Third ?? 1; |
| 71 | + } |
| 72 | +} |
| 73 | +``` |
| 74 | +```xml |
| 75 | +<TextBlock Text="This has FontSize=40" FontSize="{namespace:MultiplyLiteral 10, 8, Third=0.5}" /> |
| 76 | +``` |
| 77 | + |
| 78 | +### 从绑定接收参数 |
| 79 | + |
| 80 | +常见的场景是希望转换来自绑定的数据并更新目标属性。当所有参数都来自绑定时,通过创建一个带有 `IMultiValueConverter` 的 `MultiBinding` 来实现这一点相对简单。在下面的示例中,`MultiplyBinding` 需要两个绑定参数。如果需要混合字面量和绑定参数,创建一个 `IMultiValueConverter` 可以允许传递字面量作为构造函数或 `init` 参数。`BindingBase` 允许使用 `CompiledBinding` 和 `ReflectionBinding`,但不允许使用字面量。 |
| 81 | + |
| 82 | +```csharp |
| 83 | +public class MultiplyBinding |
| 84 | +{ |
| 85 | + private readonly BindingBase _first; |
| 86 | + private readonly BindingBase _second; |
| 87 | + public MultiplyBinding(BindingBase first, BindingBase second) |
| 88 | + { |
| 89 | + _first = first; |
| 90 | + _second = second; |
| 91 | + } |
| 92 | + public object ProvideValue() |
| 93 | + { |
| 94 | + var mb = new MultiBinding() |
| 95 | + { |
| 96 | + Bindings = new[] { _first, _second }, |
| 97 | + Converter = new FuncMultiValueConverter<double, double>(doubles => doubles.Aggregate(1d, (x, y) => x * y)) |
| 98 | + }; |
| 99 | + return mb; |
| 100 | + } |
| 101 | +} |
| 102 | +``` |
| 103 | + |
| 104 | +```xml |
| 105 | +<TextBlock FontSize="{local:MultiplyBinding {Binding Multiplier}, {Binding Multiplicand}}" |
| 106 | + Text="MarkupExtension with Bindings!" /> |
| 107 | +``` |
| 108 | + |
| 109 | +:::info |
| 110 | +另一种方法是返回 `IObservable<T>.ToBinding()`。 |
| 111 | +::: |
| 112 | + |
| 113 | +### 返回参数 |
| 114 | + |
| 115 | +为了使 `MarkupExtension` 兼容多种目标属性类型,返回 `object` 并分别处理每种支持的类型。 |
| 116 | + |
| 117 | +```csharp |
| 118 | +public object ProvideValue(IServiceProvider provider) |
| 119 | +{ |
| 120 | + var target = (IProvideValueTarget)provider.GetService(typeof(IProvideValueTarget))!; |
| 121 | + var targetProperty = target.TargetProperty as AvaloniaProperty; |
| 122 | + var targetType = targetProperty?.PropertyType; |
| 123 | + double result = First * Second * (Third ?? 1); |
| 124 | + if (targetType == typeof(double)) |
| 125 | + return result; |
| 126 | + else if (targetType == typeof(float)) |
| 127 | + return (float)result; |
| 128 | + else if (targetType == typeof(int)) |
| 129 | + return (int)result; |
| 130 | + else |
| 131 | + throw new NotSupportedException(); |
| 132 | +} |
| 133 | +``` |
| 134 | + |
| 135 | +构造函数也可以使用 `object` 方法接收参数类型,但编译时错误同样会变成运行时异常。 |
| 136 | + |
| 137 | +### MarkupExtension 属性注解 |
| 138 | + |
| 139 | +* `[ConstructorArgument]` - 关联属性可以通过构造函数参数初始化,并且如果使用了构造函数,则在 XAML 序列化时应忽略该属性。 |
| 140 | +* `[MarkupExtensionOption]`, `[MarkupExtensionDefaultOption]` - 与 `ShouldProvideOption` 一起使用,查看 `OnPlatform` 和 `OnFormFactor` 的源代码以获取示例。 |
0 commit comments