类型列表的附加属性

Question

我想创建一个可以与此语法一起使用的附加属性：

<Button>
  <Image .../>
  <ui:ToolbarItem.DisplayFilter>
    <TabItem .../>
    <TabItem .../>
    <TabItem .../>
  </ui:ToolbarItem.DisplayFilter>
</Button> 

这是我这样做的尝试：

public class ToolbarItem
{
  /// <summary>
  /// Identifies the DisplayFilter attached property. 
  /// </summary>
  public static readonly DependencyProperty DisplayFilterProperty =
    DependencyProperty.RegisterAttached(
     "DisplayFilter",
     typeof( IList ),
     typeof( ToolbarItem )
    );

  public static IList GetDisplayFilter( Control item ) {
    return (IList)item.GetValue( DisplayFilterProperty );
  }

  public static void SetDisplayFilter( Control item, IList value ) {
    item.SetValue( DisplayFilterProperty, value );
  }
}

但是，这在解析时导致异常 - System.ArgumentException：TabItem 不是属性的有效值'显示过滤器'。那么如何配置我的附加属性以便我可以使用所需的 XAML 语法？

Answer 1

请记住，XAML 基本上只是对象创建的简写形式。因此，要创建一个集合/列表作为附加的 DisplayFilter 属性的值，您必须将这些 TabItems 包含在另一个集合标记内。如果您不想这样做（这是可以理解的），则必须在第一次访问该属性时初始化该集合。

这样做只有一个问题：作为一种优化，XAML 读取器会跳过 getter 方法。您可以通过为 RegisterAttached 调用的 name 参数选择不同的名称来防止此行为：

DependencyProperty.RegisterAttached("DisplayFilterInternal", ...)

然后将调用属性 getter，您可以检查 null< /代码>。您可以在 此博文。

编辑：链接的博客文章似乎不太清楚。您仅更改传递给RegisterAttached的字符串名称，而不是静态get/set方法的名称：

public static readonly DependencyProperty DisplayFilterProperty =
    DependencyProperty.RegisterAttached(
        "DisplayFilterInternal",
        typeof(IList),
        typeof(ToolbarItem));

public static TabItemCollection GetDisplayFilter(Control item)
{ ... }

public static void SetDisplayFilter(Control item, IList value)
{ ... }

您必须在GetDisplayFilter<中初始化集合/code> 方法：

public static TabItemCollection GetDisplayFilter(Control item)
{
    var collection = (IList)item.GetValue(DisplayFilterProperty);
    if (collection == null) {
        collection = new List<object>();
        item.SetValue(DisplayFilterProperty, collection);
    }
    return collection;
}

看来您只将 TabItem 元素添加到该集合中。然后，您可以使集合类型安全，但使用 IList 不起作用，因为 XAML 解析器无法调用泛型方法 Add(T)。 Collection 和 List 也实现非泛型 IList 接口，并且可以在这种情况下使用。我建议创建一个新的集合类型，以防您将来想要对集合进行一些更改：

public class TabItemCollection : Collection<TabItem>
{
}

如果您不关心像这样显式设置集合：

<ui:ToolbarItem.DisplayFilter>
    <ui:TabItemCollection>
        <TabItem/>
    </ui:TabItemCollection>
</ui:ToolbarItem.DisplayFilter>

您可以删除 SetDisplayFilter方法。

总结：

public class TabItemCollection : Collection<TabItem>
{
}

public class ToolbarItem
{
    public static readonly DependencyProperty DisplayFilterProperty =
        DependencyProperty.RegisterAttached(
            "DisplayFilterInternal", // Shadow the name so the parser does not skip GetDisplayFilter
            typeof(TabItemCollection),
            typeof(ToolbarItem));

    public static TabItemCollection GetDisplayFilter(Control item)
    {
        var collection = (TabItemCollection)item.GetValue(DisplayFilterProperty);
        if (collection == null) {
            collection = new TabItemCollection();
            item.SetValue(DisplayFilterProperty, collection);
        }
        return collection;
    }

    // Optional, see above note
    //public static void SetDisplayFilter(Control item, TabItemCollection value)
    //{
    //    item.SetValue(DisplayFilterProperty, value);
    //}
}