WPF TemplateBinding 到 ObservableCollection

Question

我正在创建一个包含另一个用户控件的内容控件。我们称它们为 InnerControl 和 OuterControl。 InnerControl 有一个名为 "Items." 的 ObservableCollection 类型的依赖项属性我试图将其绑定到 OuterControl 中的相同依赖项属性。这是 InnerControl 代码的存根：

public class InnerControl : UserControl {

    public InnerControl() {
        InnerItems = new ObservableCollection<string>();
    }

    public ObservableCollection<string> InnerItems
    {
        get { return (ObservableCollection<string>)GetValue(InnerItemsProperty); }
        set { SetValue(InnerItemsProperty, value); }
    }
    public static DependencyProperty InnerItemsProperty =
        DependencyProperty.Register("InnerItems",
            typeof(ObservableCollection<string>),
            typeof(InnerControl),
            new PropertyMetadata());
}

外部控件包含相同的项目属性:

public class OuterControl : ContentControl {

    public OuterControl() {
        OuterItems = new ObservableCollection<string>();
    }

    static OuterControl()
    {
        DefaultStyleKeyProperty.OverrideMetadata(typeof(OuterControl),
                    new FrameworkPropertyMetadata(typeof(OuterControl)));
    }

    public ObservableCollection<string> OuterItems
    {
        get { return (ObservableCollection<string>)GetValue(OuterItemsProperty); }
        set { SetValue(OuterItemsProperty, value); }
    }
    public static DependencyProperty OuterItemsProperty =
        DependencyProperty.Register("OuterItems",
            typeof(ObservableCollection<string>),
            typeof(OuterControl),
            new PropertyMetadata());
}

然后我在 generic.xaml 文件中定义 OuterControl 的外观：

<Style TargetType="{x:Type userControls:OuterControl}">
    <Setter Property="Padding" Value="10" />
    <Setter Property="Template">
        <Setter.Value>
            <ControlTemplate TargetType="{x:Type userControls:OuterControl}">
                <Grid>
                    <Grid.RowDefinitions>
                        <RowDefinition Height="Auto"/>
                        <RowDefinition/>
                    </Grid.RowDefinitions>
                    <local:InnerControl Grid.Row="0" Grid.Column="0"
                            InnerItems="{TemplateBinding OuterItems}"/>
                    <ContentPresenter Grid.Row="1" Grid.Column="0" 
                            Content="{TemplateBinding Content}"
                            Margin="{TemplateBinding Padding}"/>
                </Grid>
            </ControlTemplate>
        </Setter.Value>
    </Setter>
</Style>

我想提请您注意上面代码中真正重要的部分是：

<local:InnerControl Grid.Row="0" Grid.Column="0" 
InnerItems="{TemplateBinding OuterItems}"/>

我希望发生的是，当项目被添加到 OuterControl 的 OuterItems 集合时，这些相同的项目将被添加到 InnerControl.InnerItems 集合。然而，这并没有发生，我不明白为什么。

我也尝试过相对绑定，这样我就可以尝试使用 TwoWay 模式等等。像这样：

InnerItems="{Binding OuterItems, Mode=TwoWay, 
RelativeSource={RelativeSource TemplatedParent}}"

但到目前为止也没有奏效。

更新

到目前为止，我认为解决了这个问题的一切都只暴露了新问题，所以我删除了之前的更新。我现在坚持的是：

如果我在构造函数中初始化 InnerItems，那么 TemplateBinding 似乎不起作用（项目永远不会更新）

如果我根本不初始化 InnerItems，则 TemplateBinding 会起作用。但是，如果 InnerControl 仅在设计器中单独使用，它就会中断，因为当设计器尝试向其添加项时 InnerItems 为 null。

更新：已解决 (?)

根据 Clemen 的建议，我需要使用此方法在构造函数中初始化 InnerItems：

SetCurrentValue(InnerItemsProperty, new ObservableCollection<string>());

手指交叉，这似乎工作，让我有两种方式（TemplateBinding 工作，控件作为独立工作）。

Answer 1

我发现@Clemens 评论很可能有正确答案。无论如何，我使用下面的代码测试了您的解决方案，它对我来说效果很好。

检查您是如何绑定和添加项目的。您没有 post 您问题中的代码。

外部控制

using System.Collections.ObjectModel;
using System.Windows;
using System.Windows.Controls;

namespace TemplateBindingTest.Controls
{
    public class OuterControl : UserControl
    {
        static OuterControl()
        {
            DefaultStyleKeyProperty.OverrideMetadata(typeof(OuterControl), new FrameworkPropertyMetadata(typeof(OuterControl)));
        }

        public ObservableCollection<string> OuterItems
        {
            get { return (ObservableCollection<string>)GetValue(OuterItemsProperty); }
            set { SetValue(OuterItemsProperty, value); }
        }
        public static DependencyProperty OuterItemsProperty =
            DependencyProperty.Register("OuterItems",
                typeof(ObservableCollection<string>),
                typeof(OuterControl),
                new PropertyMetadata(new ObservableCollection<string>()));
    }
}

内控

using System.Collections.ObjectModel;
using System.Windows;
using System.Windows.Controls;

namespace TemplateBindingTest.Controls
{
    public class InnerControl : UserControl
    {
        static InnerControl()
        {
            DefaultStyleKeyProperty.OverrideMetadata(typeof(InnerControl), new FrameworkPropertyMetadata(typeof(InnerControl)));
        }

        public ObservableCollection<string> InnerItems
        {
            get { return (ObservableCollection<string>)GetValue(InnerItemsProperty); }
            set { SetValue(InnerItemsProperty, value); }
        }

        public static DependencyProperty InnerItemsProperty =
            DependencyProperty.Register("InnerItems",
                typeof(ObservableCollection<string>),
                typeof(InnerControl),
                new PropertyMetadata(new ObservableCollection<string>()));
    }
}

Generic.xaml

<ResourceDictionary
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:controls="clr-namespace:TemplateBindingTest.Controls">

    <Style TargetType="{x:Type controls:OuterControl}">
        <Setter Property="Padding" Value="10" />
        <Setter Property="Template">
            <Setter.Value>
                <ControlTemplate TargetType="{x:Type controls:OuterControl}">
                    <Grid>
                        <Grid.RowDefinitions>
                            <RowDefinition Height="Auto"/>
                            <RowDefinition Height="Auto"/>
                            <RowDefinition/>
                        </Grid.RowDefinitions>
                        <ContentPresenter Grid.Row="0" Grid.Column="0" 
                            Content="{TemplateBinding Content}"
                            Margin="{TemplateBinding Padding}"/>
                        <ItemsControl Grid.Row="1" ItemsSource="{TemplateBinding OuterItems}" />
                        <Border Grid.Row="2" BorderThickness="1" BorderBrush="Red">
                            <controls:InnerControl  Grid.Column="0"
                            InnerItems="{TemplateBinding OuterItems}">Inner Control</controls:InnerControl>
                        </Border>
                    </Grid>
                </ControlTemplate>
            </Setter.Value>
        </Setter>
    </Style>

    <Style TargetType="{x:Type controls:InnerControl}">
        <Setter Property="Padding" Value="10" />
        <Setter Property="Template">
            <Setter.Value>
                <ControlTemplate TargetType="{x:Type controls:InnerControl}">
                    <Grid>
                        <Grid.RowDefinitions>
                            <RowDefinition Height="Auto"/>
                            <RowDefinition/>
                        </Grid.RowDefinitions>
                        <ContentPresenter Grid.Row="0" Grid.Column="0" 
                            Content="{TemplateBinding Content}"
                            Margin="{TemplateBinding Padding}"/>
                        <ItemsControl Grid.Row="1" ItemsSource="{TemplateBinding InnerItems}" />
                    </Grid>
                </ControlTemplate>
            </Setter.Value>
        </Setter>
    </Style>

</ResourceDictionary>

MainWindow.xaml

<Window x:Class="TemplateBindingTest.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:controls="clr-namespace:TemplateBindingTest.Controls"
        mc:Ignorable="d"
        Title="MainWindow" Height="350" Width="525">
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto" />
            <RowDefinition Height="Auto" />
        </Grid.RowDefinitions>
        <controls:OuterControl OuterItems="{Binding OuterItems}">Outer Control</controls:OuterControl>
        <Button Grid.Row="1" Content="Add" Click="Button_Click" HorizontalAlignment="Left" />
    </Grid>
</Window>

MainWindow.cs

using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Windows;

namespace TemplateBindingTest
{
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window
    {
        private ObservableCollection<string> _OuterItems;

        public MainWindow()
        {
            InitializeComponent();
            DataContext = this;

            _OuterItems = new ObservableCollection<string>(new List<string>()
            {
                "Test 1",
                "Test 2",
                "Test 3",
            });
        }

        public ObservableCollection<string> OuterItems
        {
            get
            {
                return _OuterItems;
            }
        }

        private void Button_Click(object sender, RoutedEventArgs e)
        {
            _OuterItems.Add(System.IO.Path.GetRandomFileName());
        }
    }
}

Answer 2

当您有集合类型依赖项属性时，您不得使用集合 class 的实例作为属性的默认值。这样做将使拥有属性的控件的所有实例都使用相同的集合实例。

所以你的属性元数据

new PropertyMetadata(new ObservableCollection<string>())

应替换为

new PropertyMetadata(null)

或者您根本没有指定任何元数据

public static DependencyProperty InnerItemsProperty =
    DependencyProperty.Register(
        "InnerItems", typeof(ObservableCollection<string>), typeof(InnerControl));

现在您必须以某种方式初始化属性值。像往常一样，您将在控件的构造函数中执行此操作，例如

public InnerControl()
{
    InnerItems = new ObservableCollection<string>();
}

当你现在像

一样绑定控件的属性

<local:InnerControl InnerItems="{Binding ...}" />

构造函数中设置的值被 Binding 产生的值所取代。

但是，当您在样式 Setter 中创建绑定时不会发生这种情况，因为样式 Setter 中的值的优先级低于所谓的本地值（请参阅 Dependency Property Value Precedence).

解决方法是通过 DependencyObject.SetCurrentValue() 方法设置默认值，该方法不设置本地值：

public InnerControl()
{
    SetCurrentValue(InnerItemsProperty, new ObservableCollection<string>()); 
}

WPF TemplateBinding 到 ObservableCollection

WPF TemplateBinding to an ObservableCollection

wpf

observablecollection

templatebinding

外部控制

内控

Generic.xaml

MainWindow.xaml

MainWindow.cs