类型列表的附加属性

时间:2009-09-19 16:34:23

标签: wpf attached-properties

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

<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不是属性'DisplayFilter'的有效值。那么如何配置我的附加属性以便我可以使用所需的XAML语法?

1 个答案:

答案 0 :(得分:34)

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

这只有一个问题:XAML阅读器跳过getter方法作为优化。您可以通过为RegisterAttached调用的名称参数选择其他名称来阻止此行为:

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

然后将调用属性getter,您可以检查null。您可以在this blog post中了解更多相关信息。

编辑:似乎链接的博客帖子不是那么清楚。您只更改 传递给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方法初始化集合:

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<T>不起作用,因为XAML解析器无法调用泛型方法Add(T)Collection<T>List<T>也实现了非通用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);
    //}
}