ItemsControl中DataGrid用户控件SelectedCells绑定失效问题

问题场景 #

• 自定义DataGrid用户控件已定义SelectedCells依赖属性，单独使用时与ViewModel的TestList双向绑定正常
• 放入ItemsControl后，无论绑定主ViewModel的TestList还是ItemsControl数据源类的对应属性，属性Setter始终不触发；仅依赖属性的PropertyChangedCallback执行，但绑定未生效，只能通过事件绑定的非MVVM方式临时解决

核心原因排查 #

1. DataContext上下文错位：ItemsControl的项模板内，自定义控件默认DataContext是当前子项实例，若绑定路径未指向正确上下文（比如误绑定主ViewModel属性但未指定来源），会导致绑定静默失效（WPF默认不抛出错误）
2. 依赖属性定义不完整：未正确设置双向绑定默认值，或PropertyChangedCallback未处理绑定源的反向同步逻辑
3. 绑定路径/模式错误：未明确绑定模式为TwoWay，或未通过RelativeSource/ElementName指定主ViewModel的访问路径
4. ItemsControl虚拟化复用：开启虚拟化后，容器复用可能导致绑定状态混乱，未在容器复用时重置依赖属性值

具体解决步骤 #

1. 修正依赖属性定义 #

确保SelectedCells依赖属性正确注册，包含双向绑定默认设置及双向同步逻辑：

public static readonly DependencyProperty SelectedCellsProperty =
    DependencyProperty.Register(
        nameof(SelectedCells),
        typeof(IList<DataGridCellInfo>),
        typeof(YourCustomDataGrid),
        new FrameworkPropertyMetadata(
            null,
            FrameworkPropertyMetadataOptions.BindsTwoWayByDefault,
            OnSelectedCellsChanged));

public IList<DataGridCellInfo> SelectedCells
{
    get => (IList<DataGridCellInfo>)GetValue(SelectedCellsProperty);
    set => SetValue(SelectedCellsProperty, value);
}

// 依赖属性值变化时同步到内部DataGrid
private static void OnSelectedCellsChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    var control = (YourCustomDataGrid)d;
    if (control.InternalDataGrid == null) return;
    
    // 避免循环触发
    if (!Equals(control.InternalDataGrid.SelectedCells, e.NewValue))
    {
        control.InternalDataGrid.SelectedCells.Clear();
        foreach (var cell in e.NewValue as IList<DataGridCellInfo> ?? Enumerable.Empty<DataGridCellInfo>())
        {
            control.InternalDataGrid.SelectedCells.Add(cell);
        }
    }
}

// 内部DataGrid选中变化时反向更新依赖属性
private void InternalDataGrid_SelectedCellsChanged(object sender, SelectedCellsChangedEventArgs e)
{
    if (!Equals(SelectedCells, InternalDataGrid.SelectedCells))
    {
        SetValue(SelectedCellsProperty, new List<DataGridCellInfo>(InternalDataGrid.SelectedCells));
    }
}

2. 修正ItemsControl内的绑定路径 #

• 绑定子项属性：确保路径指向ItemsControl数据源类的对应属性：

<ItemsControl ItemsSource="{Binding YourItemCollection}">
    <ItemsControl.ItemTemplate>
        <DataTemplate>
            <YourCustomDataGrid SelectedCells="{Binding ItemLevelSelectedCells, Mode=TwoWay}" />
        </DataTemplate>
    </ItemsControl.ItemTemplate>
</ItemsControl>

• 绑定主ViewModel属性：通过ElementName或RelativeSource指定主上下文：

<ItemsControl ItemsSource="{Binding YourItemCollection}" x:Name="MainItemsControl">
    <ItemsControl.ItemTemplate>
        <DataTemplate>
            <YourCustomDataGrid SelectedCells="{Binding DataContext.TestList, ElementName=MainItemsControl, Mode=TwoWay}" />
        </DataTemplate>
    </ItemsControl.ItemTemplate>
</ItemsControl>

3. 开启绑定调试输出 #

在App.xaml中添加配置，查看静默绑定错误：

<Application x:Class="YourApp.App"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:system="clr-namespace:System;assembly=mscorlib"
             StartupUri="MainWindow.xaml">
    <Application.Resources>
        <system:Boolean x:Key="BindingDebuggingEnabled">True</system:Boolean>
    </Application.Resources>
</Application>

在Visual Studio输出窗口（调试->输出）查看绑定相关错误，快速定位路径或类型不匹配问题。

4. 处理虚拟化复用问题 #

若ItemsControl开启虚拟化，在自定义DataGrid的OnApplyTemplate或ItemsControl的PrepareContainerForItemOverride方法中，重置依赖属性状态，避免容器复用导致的绑定异常。

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