WPF：如何实现所有 GUI 控件都可用的通用属性？

Question

是否可以实现可以在每个 GUI 控件（即 FrameworkElement）中指定的属性？ 我想象的是像Tag这样的属性，但是，我宁愿不使用Tag，而是我自己的属性。

编辑： 由于 Felice 和 CodeNaked 的回复，我再次尝试使用附加依赖属性进行第一次实验。 尽管仔细检查了所有内容，但我的附加属性 (SetAdsName()) 的设置器永远不会被调用，尽管附加属性的注册成功且没有错误。 没有错误消息 - 与 WPF 一样。

<Window xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:ads="clr-namespace:WAL.UI.Lib.Ads.Binding;assembly=WAL.UI.Lib"
        Title="Demo Page" Height="350" Width="525"
>
    <Grid>
        <Label ads:AdsNameRegistry.AdsName="SpecialLabelName" Content="Some Button Caption" />
    </Grid>
</Window>


public class AdsNameRegistry : DependencyObject
{
    public static readonly DependencyProperty AdsNameProperty = DependencyProperty.RegisterAttached( "AdsName", typeof(String), typeof(AdsNameRegistry), new FrameworkPropertyMetadata( "", FrameworkPropertyMetadataOptions.AffectsRender ) );

    public static void SetAdsName( UIElement element, String value )
    {
        try
        {
            MessageBox.Show( "SetAdsName(value=" + value + ")" );
            element.SetValue( AdsNameProperty, value );
        }
        catch (Exception ex)
        {
            Debug.Assert( false, "Exception in SetAdsName(): " + ex.Message + "\n\n" + ex );
            throw;
        }
    }

    public static String GetAdsName( UIElement element )
    {
        try
        {
            return (String) element.GetValue( AdsNameProperty );
        }
        catch (Exception ex)
        {
            Debug.Assert( false, "Exception in GetAdsName(): " + ex.Message + "\n\n" + ex );
            throw;
        }
    }
}

}

我的第一个猜测是，永远不会调用 SetAdsName()，因为 XAML 编码中没有作为父元素的元素。 但这似乎是一个错误的结论。

问候， 七

Answer 1

这可以通过使用Attached Property 来完成。 您可以通过以下示例中的注册方式在附加属性时收到通知：

public static readonly DependencyProperty XYZProperty =
            DependencyProperty.RegisterAttached(
                "XYZ",
                typeof(object),
                typeof(TargetClass),
                new PropertyMetadata(OnXYZChanged)
                );

并实现 OnXYZChanged：

private static void OnXYZChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
        {
            ...     
}

d 将是您要附加的对象，在e.NewValue 中您将找到该属性的新值。

Answer 2

您可以使用attached properties 添加您想要的任何自定义属性。示例包括 Canvas.Left 属性。

Answer 3

首先，是的，您需要一个附加属性。但是您没有正确实现该模式。

永远不要在您的 GetXxxx() 或 SetXxxx() 方法中添加任何逻辑。 GetXxxx 和 SetXxxx 应仅分别包含对 GetValue 和 SetValue 的调用：

public static String GetAdsName(UIElement element)
{
    return (string) element.GetValue(AdsNameProperty);
}
public static void SetAdsName(UIElement element, String value)
{
    element.SetValue(AdsNameProperty, value);
}

为什么它们不应该包含任何其他逻辑？因为在加载 XAML 时，不会调用您的 SetXxxx 方法。 WPF 团队有一个选择：他们可以让 XAML 加载器使用反射来查找您的 SetXxxx 方法，并在运行时动态调用它，以便您的方法可以调用 SetValue；或者他们可以删除中间人，直接调用 SetValue。他们选择了后者，因为它更简单、更高效。

如果您希望在设置属性时产生副作用，则需要在构造 PropertyMetadata 时指定 propertyChangedCallback。在你的情况下：

public static readonly DependencyProperty AdsNameProperty =
    DependencyProperty.RegisterAttached("AdsName",
        typeof(String), typeof(AdsNameRegistry),
        new FrameworkPropertyMetadata("",
            FrameworkPropertyMetadataOptions.AffectsRender, OnAdsNameChanged));

private static void OnAdsNameChanged(DependencyObject sender,
    DependencyPropertyChangedEventArgs e)
{
    // do something with the new value
}