如何让自定义UserControl的DependencyProperty返回ViewModel属性值？

问题背景 #

我正在将自定义列表选择UserControl封装到DLL中，期望外部代码通过绑定Result属性双向同步选择结果：外部赋值时控件能初始化选中项，控件内部选择变化时能同步回外部绑定的属性。但目前仅能实现外部到控件的单向同步，控件内部的SelectedList变化无法反馈到Result绑定属性。

核心原因 #

当前的Result依赖属性仅在外部赋值时触发ResultChangedEvent更新ViewModel的SelectedList，但ViewModel的SelectedList变化时没有通知依赖属性更新，导致双向绑定的反向同步失效。

解决方案 #

通过以下步骤实现完整的双向绑定：

1. 监听ViewModel中SelectedList的变化 #

在CustomControl初始化时，订阅ViewModel中SelectedList的CollectionChanged事件，当列表内容变化时主动更新Result依赖属性。

2. 处理外部集合的同步逻辑 #

如果外部绑定的是ObservableCollection类型，优先同步集合内容而非替换实例，避免破坏外部代码对集合的引用。

修改后的代码示例 #

CustomControl.cs 修改

public partial class CustomControl : UserControl
{
    public IEnumerable<string> Result
    {
        get { return (IEnumerable<string>)GetValue(resultProperty); }
        set { SetValue(resultProperty, value); }
    }
    public static readonly DependencyProperty resultProperty = DependencyProperty.Register("Result", typeof(IEnumerable<string>), typeof(CustomControl), 
        new FrameworkPropertyMetadata(null, FrameworkPropertyMetadataOptions.BindsTwoWayByDefault, ResultChangedEvent));
    
    private static void ResultChangedEvent(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        var uc = d as CustomControl;
        if (uc == null || e.NewValue == null) return;
        uc.viewModel.InitResult((IEnumerable<string>)e.NewValue);
    }

    // Source属性相关代码...

    internal CustomControlViewModel viewModel;
    public CustomControl()
    {
        InitializeComponent();
        ContentGrid.DataContext = viewModel = new CustomControlViewModel();
        // 订阅SelectedList的集合变化事件
        viewModel.SelectedList.CollectionChanged += SelectedList_CollectionChanged;
    }

    private void SelectedList_CollectionChanged(object sender, System.Collections.Specialized.NotifyCollectionChangedEventArgs e)
    {
        // 根据外部绑定的集合类型选择同步方式
        if (Result is ObservableCollection<string> externalCollection)
        {
            // 同步内容，保留外部集合实例
            externalCollection.Clear();
            foreach (var item in viewModel.SelectedList)
            {
                externalCollection.Add(item);
            }
        }
        else
        {
            // 外部不是ObservableCollection，直接返回新集合实例
            SetValue(resultProperty, new ObservableCollection<string>(viewModel.SelectedList));
        }
    }
}

CustomControlViewModel.cs 优化（可选）

将SelectedList设为只读属性，避免外部代码意外替换集合实例，同时实现INotifyPropertyChanged方便后续扩展：

using System.ComponentModel;
using System.Runtime.CompilerServices;
using System.Collections.ObjectModel;
using System.Collections.Specialized;

internal class CustomControlViewModel : INotifyPropertyChanged
{
    public ObservableCollection<string> SourceList { get; } = new ObservableCollection<string>();

    // 只读属性，防止外部替换集合实例
    public ObservableCollection<string> SelectedList { get; } = new ObservableCollection<string>();

    public void InitResult(IEnumerable<string> items)
    {
        SelectedList.Clear();
        foreach (var name in items.Distinct())
            SelectedList.Add(name);
    }       

    public void OtherEventHandleList(string text)
    {
        if (!SelectedList.Contains(text))
        {
            SelectedList.Add(text);
        }
    }

    // 实现INotifyPropertyChanged接口
    public event PropertyChangedEventHandler PropertyChanged;
    protected void OnPropertyChanged([CallerMemberName] string propertyName = null)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }
}

关键说明 #

• 通过CollectionChanged事件监听内部选择列表的变化，主动触发Result属性更新，完成双向绑定的反向同步
• 针对外部绑定的集合类型做差异化处理：如果是ObservableCollection则同步内容，否则返回新集合实例，兼顾兼容性和引用稳定性
• 将ViewModel的集合属性设为只读，避免集合实例被意外替换导致事件监听失效

内容的提问来源于stack exchange，提问作者tp1415926535