如何为自定义控件中的列表属性进行绑定？

Question

由于ListBox 不允许您双向绑定到其SelectedItems 属性，因此我创建了自己的自定义控件MultipleSelectionListBox。它添加了属性BindableSelectedItems，让您可以将IEnumerable 绑定到它。

public class MultipleSelectionListBox : ListBox
{
    public static readonly DependencyProperty BindableSelectedItemsProperty =
        DependencyProperty.Register("BindableSelectedItems",
            typeof(IEnumerable), typeof(MultipleSelectionListBox),
            new FrameworkPropertyMetadata(default(IEnumerable),
                FrameworkPropertyMetadataOptions.BindsTwoWayByDefault, OnBindableSelectedItemsChanged));

    public IEnumerable BindableSelectedItems
    {
        get => (IEnumerable)GetValue(BindableSelectedItemsProperty);
        set => SetValue(BindableSelectedItemsProperty, value);
    }

    protected override void OnSelectionChanged(SelectionChangedEventArgs e)
    {
        base.OnSelectionChanged(e);
        BindableSelectedItems = SelectedItems;
    }

    private static void OnBindableSelectedItemsChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        if (d is MultipleSelectionListBox listBox)
            listBox.SetSelectedItems(listBox.BindableSelectedItems);
    }
}

我绑定到的视图模型的属性是IEnumerable<string> 类型，并且绑定不起作用。当列表框的选择改变时，视图模型的属性总是接收null。

如果我将BindableSelectedItems 的类型更改为IEnumerable<string>，则绑定有效。这让我相信绑定不喜欢类型不匹配。我是否不得不明确指定列表项的类型，还是有办法让它保持通用？如果能够将相同的MultipleSelectionListBox 用于其他类型的项目，那就太好了。

Answer 1

这是因为，SelectedItems 将始终是 System.Collections.IList {System.Windows.Controls.SelectedItemCollection} 类型。因此，当您尝试使用IEnumerable 时，您直接将SelectedItems 分配给BindableSelectedItems。演员表无效并且已将 null 发送到您的 ViewModel 属性。

其中，当您将类型设置为 IEnumerable<string> 时，您会将 SelectedItems 转换为 string 集合，例如 BindableSelectedItems = SelectedItems.Cast<string>();，它与 ViewModel 中的属性类型匹配并且有效。

我看到你想让它通用。为此，您可以尝试类似的方法，

ListBox控件代码

public class MultipleSelectionListBox : ListBox
{
    public static readonly DependencyProperty BindableSelectedItemsProperty =
        DependencyProperty.Register("BindableSelectedItems",
            typeof(IList), typeof(MultipleSelectionListBox),
            new FrameworkPropertyMetadata(default(IList),
                FrameworkPropertyMetadataOptions.BindsTwoWayByDefault, OnBindableSelectedItemsChanged));

    public IList BindableSelectedItems
    {
        get => (IList)GetValue(BindableSelectedItemsProperty);
        set => SetValue(BindableSelectedItemsProperty, value);
    }

    protected override void OnSelectionChanged(SelectionChangedEventArgs e)
    {
        base.OnSelectionChanged(e);

        IList selectedItemsList = BindableSelectedItems;
        if (selectedItemsList == null)
            selectedItemsList = (IList)Activator.CreateInstance(ItemsSource.GetType());
        selectedItemsList.Clear();

        foreach (var item in SelectedItems)
            selectedItemsList.Add(item);

        BindableSelectedItems = selectedItemsList;
    }

    private static void OnBindableSelectedItemsChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        if (d is MultipleSelectionListBox listBox)
            listBox.SetSelectedItems(listBox.BindableSelectedItems);
    }
}

视图模型

public class ViewModel
{
    public IEnumerable Items { get; set; }
    public IEnumerable SelectedItems { get; set; }

    public ViewModel()
    {
        Items = new List<string> { "Test", "Test1" };
        SelectedItems = new List<string> { "Test" };
    }
}

我已经用常见的场景进行了测试，它工作正常。