WPF自定义控件：如何将ItemsSource属性映射到子控件依赖属性？

背景 #

我正在制作一个包含多个ListBox的自定义控件，希望它符合MVVM规范，因此让XAML和代码后置与任何ViewModel解耦。其中一个ListBox仅显示TextBox列表，另一个则以Canvas为宿主以图形化方式展示数据，这两个ListBox都是该自定义控件的子控件。

自定义控件模板伪代码示例：

<CustomControl>
    <Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition/>
            <ColumnDefinition/>
        </Grid.ColumnDefinitions>
    <ListBox1 Grid.Column="0"/>
    <ListBox2 Grid.Column="1"/>
</CustomControl>

该自定义控件的代码后置包含一个作为ItemsSource的依赖属性，实现方式较为标准：

public IEnumerable ItemsSource
{
    get { return (IEnumerable)GetValue(ItemsSourceProperty); }
    set { SetValue(ItemsSourceProperty, value); }
}

public static readonly DependencyProperty ItemsSourceProperty =
    DependencyProperty.Register("ItemsSource", typeof(IEnumerable), typeof(UserControl1), new PropertyMetadata(new PropertyChangedCallback(OnItemsSourcePropertyChanged)));

private static void OnItemsSourcePropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e)
{
    var control = sender as UserControl1;
    if (control != null)
        control.OnItemsSourceChanged((IEnumerable)e.OldValue, (IEnumerable)e.NewValue);
}

遇到的问题 #

由于两个ListBox使用同一数据源但展示方式不同，我希望将父视图的ItemsSource依赖属性作为两个子控件的ItemsSource。从ViewModel层面，该数据源可以是ObservableCollection<ChildViewModels>、IEnumerable或其他类型。

如何将ItemsSource对应的ViewModel属性指向子视图的依赖属性？

我希望实现类似在自定义控件外的绑定效果：

父ViewModel示例（省略部分代码，假设功能正常）：

public class ParentViewModel
{
    public ObservableCollection<ChildViewModel> ChildViewModels;
}

子ViewModel示例（省略INotifyPropertyChanged及相关逻辑）：

public class ChildViewModel
{
    public string Name {get; set;}
    public string ID {get; set;}
    public string Description {get; set;}   
}

控件示例（省略DataContext设置，假设已正确配置）：

<ListBox ItemsSource="{Binding ChildViewModels}">
    <ListBox.ItemsTemplate>
        <StackPanel>
            <TextBlock Text="{Binding Name}"/>
            <TextBlock Text ="{Binding Description}"/>
        </StackPanel>
    </ListBox.ItemsTemplate>
</ListBox>

如何在自定义控件中实现类似操作，将ItemsSource的属性传递给子视图？

解决方案 #

有两种常用方式可以实现自定义控件的ItemsSource传递给内部子ListBox，且完全符合MVVM规范：

1. XAML模板内直接绑定（推荐）

在自定义控件的ControlTemplate里，通过RelativeSource绑定直接关联到自定义控件自身的ItemsSource依赖属性，无需修改代码后置。

修改后的自定义控件模板代码：

<CustomControl xmlns:local="clr-namespace:YourNamespace">
    <Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition/>
            <ColumnDefinition/>
        </Grid.ColumnDefinitions>
        <!-- 绑定到自定义控件的ItemsSource -->
        <ListBox x:Name="ListBox1" Grid.Column="0" 
                 ItemsSource="{Binding RelativeSource={RelativeSource AncestorType={x:Type local:UserControl1}}, Path=ItemsSource}">
            <!-- 这里定义ListBox1的ItemTemplate -->
        </ListBox>
        <ListBox x:Name="ListBox2" Grid.Column="1" 
                 ItemsSource="{Binding RelativeSource={RelativeSource AncestorType={x:Type local:UserControl1}}, Path=ItemsSource}">
            <!-- 这里定义ListBox2的图形化ItemTemplate -->
        </ListBox>
    </Grid>
</CustomControl>

• 注意：local是自定义控件所在命名空间的前缀，需根据实际项目调整命名空间声明。
• 这种方式完全基于XAML绑定，无需编写额外C#代码，符合MVVM视图与逻辑分离的要求。

2. 代码后置处理（适合需要额外逻辑的场景）

如果需要在ItemsSource变更时执行额外逻辑（比如类型校验、数据转换），可以在自定义控件的OnItemsSourceChanged方法中直接给子ListBox赋值：

首先确保自定义控件模板里的子ListBox有x:Name标识，然后修改代码后置的OnItemsSourceChanged方法：

private void OnItemsSourceChanged(IEnumerable oldValue, IEnumerable newValue)
{
    // 直接给两个子ListBox赋值ItemsSource
    ListBox1.ItemsSource = newValue;
    ListBox2.ItemsSource = newValue;
    
    // 这里可以添加额外逻辑，比如转换数据源类型、注册集合变更监听等
}

• 这种方式适合需要对数据源进行预处理的场景，比如将IEnumerable转换为ObservableCollection以支持自动更新。

额外注意事项 #

• 如果子ListBox需要对数据源进行独立的过滤/排序，建议在自定义控件中新增ICollectionView类型的依赖属性，通过CollectionViewSource包装原ItemsSource，避免直接修改原集合。
• 确保自定义控件的DataContext不会被意外覆盖，否则RelativeSource绑定会失效（可通过设置DataContext="{Binding RelativeSource={RelativeSource Self}}"在自定义控件根节点避免继承外部DataContext）。

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