将集合绑定到自定义控件属性答案

【问题标题】：Binding a collection to a custom control property将集合绑定到自定义控件属性
【发布时间】：2013-12-25 03:30:36
【问题描述】：

我没有运气尝试将数据集合绑定到我的自定义控件的属性。我已经实现了这个控件的字符串属性的机制（在这里有一点帮助），并期望集合类型同样简单。但是我不能让它再次工作。

这是我的自定义控件视图

<UserControl x:Class="BadaniaOperacyjne.Controls.Matrix"
            mc:Ignorable="d" Name="CustomMatrix"
            d:DesignHeight="300" d:DesignWidth="300">
    <Grid>
        <Grid.RowDefinitions>
            <!-- ... -->
        </Grid.RowDefinitions>
        <Grid.ColumnDefinitions>
            <!-- ... -->
        </Grid.ColumnDefinitions>
        <TextBlock Grid.Row="0" Grid.Column="1" Text="{Binding ElementName=CustomMatrix, Path=Title}"/>
        <Grid Grid.Row="2" Grid.Column="1" Name="contentGrid">
            <ListBox ItemsSource="{Binding ElementName=CustomMatrix, Path=ItemsList}">
                <ListBox.ItemTemplate>
                    <DataTemplate>
                        <TextBlock Text="{Binding}"/>
                    </DataTemplate>
                </ListBox.ItemTemplate>
            </ListBox>
        </Grid>
    </Grid>
</UserControl>

及其代码隐藏

#region ItemsList Property
public static readonly DependencyProperty ItemsListProperty =
    DependencyProperty.Register("ItemsList", typeof(ObservableCollection<object>), typeof(Matrix), new PropertyMetadata(new ObservableCollection<object>(), new PropertyChangedCallback(ItemsListChanged)));
public ObservableCollection<object> ItemsList
{
    get { return GetValue(ItemsListProperty) as ObservableCollection<object>; }
    set { SetValue(ItemsListProperty, value); }
}
private void ItemsListChanged(object value)
{
    System.Diagnostics.Debug.WriteLine("matrix: items list changed " + value);
    if (ItemsList != null)
    {
        ItemsList.CollectionChanged += ItemsList_CollectionChanged;
        System.Diagnostics.Debug.WriteLine("got " + string.Join(",", ItemsList.ToList()));
    }
    else
    {
        System.Diagnostics.Debug.WriteLine("got null");
    }
}

void ItemsList_CollectionChanged(object sender, System.Collections.Specialized.NotifyCollectionChangedEventArgs e)
{
    System.Diagnostics.Debug.WriteLine("matrix: current items list collection changed");
}
private static void ItemsListChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    // a breakpoint
    ((Matrix)d).ItemsListChanged(e.NewValue);
}
#endregion

// showing the Title property implementation just to state that
// it is done the same way as for ItemsList
#region Title Property
public static readonly DependencyProperty TitleProperty = 
    DependencyProperty.Register("Title", typeof(string), typeof(Matrix), new PropertyMetadata("", new PropertyChangedCallback(TitleChanged)));
public string Title
{
    get { return (string)GetValue(TitleProperty); }
    set { SetValue(TitleProperty, value); }
}
private void TitleChanged(string title)
{
    System.Diagnostics.Debug.WriteLine("matrix: title changed to: " + title);
}
private static void TitleChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    ((Matrix)d).TitleChanged((string)e.NewValue);
}
#endregion

这就是我尝试绑定到该控件的方式

<custom:Matrix x:Name="customMatrix" DockPanel.Dock="Top" Title="{Binding Title}" ItemsList="{Binding Items}"/>

主页面的代码隐藏是

//internal ObservableCollection<List<int>> ItemsList { get; set; }
public class ViewModel : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;

    public ViewModel()
    {
        Items = new ObservableCollection<int> { 1, 2, 3, 4, 5, 6};
    }

    void Items_CollectionChanged(object sender, System.Collections.Specialized.NotifyCollectionChangedEventArgs e)
    {
        System.Diagnostics.Debug.WriteLine("problem manager: items list changed " + e.NewItems.Count);
    }

    public ObservableCollection<int> Items { get; set; }

    protected string title;
    public string Title
    {
        get { return title; }
        set
        {
            if (title != value)
            {
                title = value;
                NotifyPropertyChanged("Title");
            }
        }
    }

    protected void NotifyPropertyChanged(string name)
    {
        PropertyChangedEventHandler handler = PropertyChanged;
        if (handler != null)
        {
            handler(this, new PropertyChangedEventArgs(name));
        }
    }
}

public ViewModel VM { get; private set; }

// this is the window constructor
private ProblemManager() 
{
    VM = new ViewModel();

    DataContext = VM;
    InitializeComponent();

    VM.Title = "title";
}

private int i = 0;
private void btnAddRow_Click(object sender, RoutedEventArgs e)
{
    // when doing either of these two lines below, 
    // the control breakpoint is never hit
    VM.Items.Add(++i);
    VM.Items = new ObservableCollection<int> { 2, 3 };

    // however, when directly assigning to the control's property, 
    // the event is raised and the breakpoint is hit and the UI is updated
    customMatrix.ItemsList = new ObservableCollection<object> { 1, 2, 3 };
    customMatrix.ItemsList.Add(66);
    // and this of course makes the control's title update
    VM.Title = (++i).ToString();
}

我相信，控件的Title 和ItemsList 的DependencyPropertys 都是以相同的方式创建的。尽管如此，该绑定可能无法正常工作，因为该绑定不会引发ItemsListChanged 事件。所以，问题是我无法通过 XAML 将我的窗口的 ViewModel.Items 集合绑定到控件的 ItemsList 集合。为控件中的集合创建DependencyProperty 与为简单的string 属性创建DependencyProperty 有什么不同吗？

【问题讨论】：

与Title 的绑定是有效还是无效？
是的，它不仅会更改属性值，还会刷新 UI。目前唯一不起作用的是ItemsList绑定:(
在 CustomMatrix 中查看名称差异一个地方的大写 c 和其他小写 c
您的意思是控件的内部 xaml 名称和 custom:Matrix 的窗口名称？这有关系吗？其他绑定仍然有效。
我相信这些不相关。大写的 C 代表控件的内部代码，而小写的代表窗口。毕竟，按照@RohitVats 告诉我的操作让它起作用。

标签： c# wpf data-binding collections custom-controls

【解决方案1】：

问题在于您的DependencyProperty 注册。 Co-variance is not applicable for generic lists 即你不能这样做 -

ObservableCollection<object> objects = new ObservableCollection<int>();

您已将 DP 的类型声明为 ObservableCollection<object>，但将其与 ObservableCollection<int> 类型的列表绑定。

您应该change either type of DP to ObservableCollection<int> 或change binding collection type to ObservableCollection<object>。

public ViewModel()
{
    Items = new ObservableCollection<object> { 1, 2, 3, 4, 5, 6};
}

public ObservableCollection<object> Items { get; set; }

【讨论】：

这解决了我的问题，但如果我做对了，就不可能将 any 类型绑定到控件，我的意思是我不能相互绑定到这个集合字符串或整数。还是有可能？
否 ObservableCollection<object> 不能绑定到 ObservableCollection<string>。相反，您可以将返回类型设为 IEnumerable，它可以绑定到任何集合。
即使ItemsControl 的ItemsSource 属性也是IEnumerable 类型。
但是IEnumerable 是否也需要参数化为object？如果是这样，那么它没有多大帮助，我宁愿我可以在同一种集合中拥有各种集合内容类型:(
不，您不必使用参数化版本，因为所有集合都继承自 IEnumerable，所以它可以工作。

【解决方案2】：

经过这么长时间，我有点需要这两种方式：

能够定义任何类型的项目的集合
在添加/删除项目等时收到通知。

为了更精确，我正在研究类似面包屑的控制。

确实，ItemsSource DP 是用 IList 类型定义的，以允许上述“通用性”：

public static readonly DependencyProperty ItemsSourceProperty =
  DependencyProperty.Register("ItemsSource", typeof(IList), typeof(BreadCrumbUserControl), 
    new PropertyMetadata(null, new PropertyChangedCallback(OnItemsSourceChanged)));

这就是我如何使用我的面包屑：

<views:BreadCrumbUserControl ItemsSource="{Binding Items}" SelectedItem="{Binding SelectedItem, Mode=TwoWay}"/>

其中 Items 是自定义类型的 ObservableCollection：

public ObservableCollection<BaseItem> Items { get; set; }

确实它工作正常，我的 ItemsSource 本地属性指向正确的集合，但是当一个项目添加到 ObservableCollection 时，我需要在我的 UserControl 中得到通知。

所以，我在我的 ItemsSource DP 上使用了 PropertyChangedCallback 委托。

private static void OnItemsSourceChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
  BreadCrumbUserControl thisUserControl = (BreadCrumbUserControl)d;
  (e.NewValue as INotifyCollectionChanged).CollectionChanged += thisUserControl.BreadCrumbUserControl_CollectionChanged;
}

这是对我有用的技巧，因为我的输入参考实际上是上层定义的 ObservableCollection。

这两个目标现在都实现了：使用任何自定义类型的集合，并且在同一类型中，随时了解情况。

如果设置了协议，则可以使用反射来更改我们自定义类型的值。

这只是一个迭代我的集合的示例，该集合在我的 UserControl 的世界中有一些未知类型：

foreach (var baseItem in ItemsSource)
{
   baseItem.GetType().GetProperty("IsActive").SetValue(baseItem, false);
}

【讨论】：