WPF：为什么逻辑子元素上不会触发DataContextChanged事件？

Question

我有一个问题，我的自定义面板控件的逻辑子元素上没有触发DataContextChanged事件。我已经缩小了范围：

从由向导生成的WPF应用程序开始，我添加：

    private void Window_Loaded( object sender, RoutedEventArgs e )
    {
        var elt = new FrameworkElement();
        this.AddLogicalChild( elt );
        DataContext = 42;
        Debug.Assert( (int)elt.DataContext == 42 );
    }

据我了解，这是因为DataContext是一个可继承的依赖属性。现在，我在窗口（this）和它的逻辑子元素上都添加了DataContextChanged事件处理程序：

    this.DataContextChanged += 
        delegate { Debug.WriteLine( "this:DataContextChanged" ); };
    elt.DataContextChanged += 
        delegate { Debug.WriteLine( "elt:DataContextChanged" ); };

如果我运行这个程序，只有第一个事件处理程序会执行。为什么会这样呢？如果我不使用 AddLogicalChild( elt )，而是采用以下方法：

this.Content = elt;

两个处理程序都将执行。但在我的情况下，这不是一个选项 - 我正在向我的控件添加FrameworkContentElements，它们不应该是可视子元素。

这里发生了什么？除了AddLogicalChild（）之外，我还需要做些什么才能使其正常工作？

（幸运的是，有一个相当简单的解决方法 - 只需将元素的DataContext绑定到窗口的DataContext即可）

BindingOperations.SetBinding( elt, FrameworkElement.DataContextProperty, 
            new Binding( "DataContext" ) { Source = this } );

谢谢。

- Danko Durbić

Answer 1

你需要同时覆盖 LogicalChildren 属性:

protected override System.Collections.IEnumerator LogicalChildren
{
    get { yield return elt; }
}

当然，您还需要返回基本实现定义的任何逻辑子项。

- Kent Boogaart

Answer 2

如果您创建一个具有多个内容对象的自定义控件，应确保：

• 通过AddLogicalChild()将内容对象添加到逻辑树中
• 创建自己的枚举器类并在重写的LogicalChildren属性中返回其实例

如果您不将内容对象添加到逻辑树中，则可能会遇到问题，例如无法解析ElementNames的绑定（ElementName通过FindName进行解析，而FindName又使用逻辑树查找元素）。

更危险的是，我的经验是，如果您错过将对象添加到逻辑树中，则在某些情况下ElementName解析工作正常，在其他情况下则不起作用。

如果您不覆盖LogicalChildren，则DataContext不会像上面描述的那样更新。

这里有一个简单的SplitContainer的简短示例：

    public class SplitContainer : Control
{
    static SplitContainer()
    {
        DefaultStyleKeyProperty.OverrideMetadata(typeof(SplitContainer), new FrameworkPropertyMetadata(typeof(SplitContainer)));
    }

    /// <summary>
    /// Identifies the <see cref="Child1"/> property.
    /// </summary>
    public static readonly DependencyProperty Child1Property =
        DependencyProperty.Register(nameof(Child1), typeof(object), typeof(SplitContainer), new FrameworkPropertyMetadata(Child1PropertyChangedCallback));

    /// <summary>
    /// Left Container
    /// </summary>
    public object Child1
    {
        get { return (object)GetValue(Child1Property); }
        set { SetValue(Child1Property, value); }
    }

    /// <summary>
    /// Identifies the <see cref="Child2"/> property.
    /// </summary>
    public static readonly DependencyProperty Child2Property =
        DependencyProperty.Register(nameof(Child2), typeof(object), typeof(SplitContainer), new FrameworkPropertyMetadata(Child2PropertyChangedCallback));

    /// <summary>
    /// Right Container
    /// </summary>
    public object Child2
    {
        get { return (object)GetValue(Child2Property); }
        set { SetValue(Child2Property, value); }
    }

    private static void Child1PropertyChangedCallback(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        var splitContainer = (SplitContainer)d;

        if (e.OldValue != null)
        {
            splitContainer.RemoveLogicalChild(e.OldValue);
        }
        if (e.NewValue != null)
        {
            splitContainer.AddLogicalChild(((object)e.NewValue));
        }
    }

    private static void Child2PropertyChangedCallback(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        var splitContainer = (SplitContainer)d;

        if (e.OldValue != null)
        {
            splitContainer.RemoveLogicalChild(e.OldValue);
        }
        if (e.NewValue != null)
        {
            splitContainer.AddLogicalChild(((object)e.NewValue));
        }
    }

    protected override IEnumerator LogicalChildren
    {
        get
        {
            return new SplitContainerLogicalChildrenEnumerator(this);
        }
    }
}

SplitContainerLogicalChildrenEnumerator：

    internal class SplitContainerLogicalChildrenEnumerator : IEnumerator
{
    private readonly SplitContainer splitContainer;
    private int index = -1;

    public SplitContainerLogicalChildrenEnumerator(SplitContainer splitContainer)
    {
        this.splitContainer = splitContainer;
    }

    public object Current
    {
        get
        {
            if (index == 0)
            {
                return splitContainer.Child1;
            }
            else if (index == 1)
            {
                return splitContainer.Child2;
            }
            throw new InvalidOperationException("No child for this index available");
        }
    }

    public bool MoveNext()
    {
        index++;
        return index < 2;
    }

    public void Reset()
    {
        index = -1;
    }
}

样式（例如在Themes/generic.xaml中）：

<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                xmlns:scm="clr-namespace:System.ComponentModel;assembly=PresentationFramework"
                xmlns:sys="clr-namespace:System;assembly=mscorlib"
                xmlns:local="clr-namespace:SplitContainerElementNameProblem">
<Style TargetType="{x:Type local:SplitContainer}">
    <Setter Property="Template">
        <Setter.Value>
            <ControlTemplate TargetType="{x:Type local:SplitContainer}">
                <Grid>
                    <Grid.ColumnDefinitions>
                        <ColumnDefinition Width="*" />
                        <ColumnDefinition Width="*" />
                    </Grid.ColumnDefinitions>
                    <ContentPresenter Grid.Column="0"
                                      Content="{TemplateBinding Child1}" />
                    <ContentPresenter Grid.Column="1"
                                      Content="{TemplateBinding Child2}" />
                </Grid>
            </ControlTemplate>
        </Setter.Value>
    </Setter>
</Style>

示例展示了每个绑定都正常工作的情况：

XAML：

<Window x:Class="SplitContainerElementNameProblem.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:local="clr-namespace:SplitContainerElementNameProblem"
    mc:Ignorable="d"
    Title="MainWindow" Height="450" Width="800">
<Grid>
    <Grid.RowDefinitions>
        <RowDefinition Height="Auto" />
        <RowDefinition Height="*" />
    </Grid.RowDefinitions>
    <Grid Grid.Row="0">
        <TextBox x:Name="text1" Text="abc" />
    </Grid>
    <local:SplitContainer Grid.Row="1">
        <local:SplitContainer.Child1>
            <TextBox x:Name="text2"
                     Text="{Binding ElementName=text1, Path=Text}" />
        </local:SplitContainer.Child1>
        <local:SplitContainer.Child2>
            <StackPanel>
                <TextBox x:Name="text3"
                         Text="{Binding ElementName=text2, Path=Text}" />
                <TextBox x:Name="text4"
                         Text="{Binding MyName}" />
            </StackPanel>
        </local:SplitContainer.Child2>
    </local:SplitContainer>
</Grid>

XAML.cs

    public partial class MainWindow : Window
{
    public MainWindow()
    {
        InitializeComponent();

        DataContext = this;

        MyName = "Bruno";
    }

    public string MyName
    {
        get;
        set;
    }
}

- Lord Tasci