DataTemplate中的自定义DependencyProperty集

本文关键字：DependencyProperty 自定义 DataTemplate | 更新日期: 2023-09-27 18:25:03

我正在使用一个自定义控件，该控件具有多个用户定义的依赖属性。我遇到了这个问题中描述的相同问题。

我的控件正在其构造函数中设置自定义依赖项属性的默认值。当我在DataTemplate中使用控件时，总是使用构造函数中设置的值，即使我试图在XAML中设置它也是如此。

链接问题的答案解释说，C#代码中设置的值具有更高的优先级，更好的方法是在依赖属性的元数据中指定默认值。

在我的情况下，我不能指定默认值，因为dependency属性没有一个适用于所有情况的默认值。默认值取决于另一个属性，所以我必须在创建控件时查找它们，而不是在注册属性时查找。

这里有一些代码来帮助说明我的问题：

public partial class MyControl : UserControl
{
    public static readonly DependencyProperty MyProperty = 
            DependencyProperty.Register(
                "MyProperty",
                typeof(int),
                typeof(MyControl),
                new FrameworkPropertyMetadata(
                    int.MinValue,
                    FrameworkPropertyMetadataOptions.None,
                    new PropertyChangedCallback("OnMyPropertyChanged")));
    public MyControl() : base()
    {
        InitializeComponent();
        this.MyProperty = GetDefaultPropertyValue();
    }
    public int MyProperty
    {
        get { return (int)GetValue(MyProperty); }
        set { SetValue(MyProperty, value); }
    }
    private int GetDefaultPropertyValue()
    {
        // look up the appropriate default based on some other criteria
        return 42;
        // (in reality, the default value for "MyProperty"
        // depends on the value of a "Mode" custom DependencyProperty.
        // this is just hard coded for testing)
    }   
}

XAML用法如下所示：

<!-- View displays 4 (desired) -->
<local:MyControl MyProperty="4" />
<!-- View displays default of 42 (desired) -->
<local:MyControl />
<!-- View displays default of 42 (wanted 4) -->
<DataTemplate x:Key="MyTemplate">
    <local:MyControl MyProperty="4"/>
</DataTemplate>

总结：

所需的行为是首先使用XAML中的值。如果XAML中没有指定该值，那么我希望回退到控件构造函数中设置的默认值。

如果我只是将控件直接包含在视图中，我就会得到预期的行为。如果控件在DataTemplate中使用，那么我总是在构造函数中获得默认设置（即使数据模板显式设置了另一个值）。

在模板中使用控件时，是否有其他方法可以指定默认值？我能想到的唯一选项是将控件分解为几个独立但相似的控件，每个控件都使用一个在dependency属性中注册的默认值（这消除了基于Mode属性设置默认值的需要）。

DataTemplate中的自定义DependencyProperty集

在OnApplyTemplate中设置默认值，同时添加一个小检查应该可以解决这个问题：

public override void OnApplyTemplate()
{
    base.OnApplyTemplate();
    // Only set the default value if no value is set.
    if (MyProperty == (int)MyPropertyProperty.DefaultMetadata.DefaultValue)
    {
        this.MyProperty = GetDefaultPropertyValue();
    }
}

请注意，尽管这会起作用，但并不理想，因为通过代码设置属性的值基本上会清除该属性的任何数据绑定。例如，一旦您在代码中调用MyProperty = 42，以下绑定将不再工作：

<local:MyControl MyProperty="{Binding SomeProperty}" />

应该可以在维护任何绑定的同时设置值，方法是使用SetCurrentValue(MyPropertyProperty, GetDefaultPropertyValue());而不是MyProperty = GetDefaultPropertyValue()来修改属性，但我也不确定我是否太喜欢这样。

更好的解决方案

我要做的是在现有属性的基础上引入一个新的只读属性，它将作为一个计算属性。例如：

private static readonly DependencyPropertyKey MyCalculatedPropertyPropertyKey =
    DependencyProperty.RegisterReadOnly("MyCalculatedProperty", typeof(int), typeof(MyControl),
    new PropertyMetadata(int.MinValue));
public static readonly DependencyProperty MyCalculatedPropertyProperty = MyCalculatedPropertyPropertyKey.DependencyProperty;
public int MyCalculatedProperty
{
    get { return (int)GetValue(MyCalculatedPropertyProperty); }
    private set { SetValue(MyCalculatedPropertyPropertyKey, value); }
}
private static void OnMyPropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    ((MyControl)d).MyCalculatedProperty = (int)e.NewValue;
}
public MyControl()
    : base()
{
    InitializeComponent();
    MyCalculatedProperty = GetDefaultPropertyValue();
}