c# - 扩展 WPF 第三方控件以启用对现有属性的双向绑定(bind)

Question

我目前正在开发一个项目，用户将输入动态编译和执行的 C# 脚本。我现在将跳过提供更多细节，因为稍后我可能会对项目的其他方面有疑问。

由于一些我无法控制的高层决策，用户界面将使用 WPF 开发，Quantum Whale Editor.NET 控件将用作编辑器。可悲的是，QWhale Editor.NET 的 WPF 版本似乎还没有完全成熟，因此它缺乏文档，最糟糕的是，它似乎并不友好。

虽然我对 WPF 还是个新手，但我对 MVVM 比较熟悉，所以我很乐意应用它。然而，当我测试评估版并尝试将编辑器的文本绑定(bind)到模型的属性时，我遇到了第一个挑战，并收到一个不可能的异常:

A 'Binding' cannot be set on the 'Text' property of type 'TextEditor'. A 'Binding' can only be set on a DependencyProperty of a DependencyObject.

在检查备选方案时尝试了 AvalonEdit，我想起了另一个 Stack Overflow 问题:Making AvalonEdit MVVM Compatible .所以我遵循了相同的概念。

我已经定义了一个继承自编辑器的类，添加了一个依赖属性，并首先尝试使用 new 将其与隐藏编辑器的原始 Text 属性结合起来。但显然这是一个远景，我的属性没有被使用，直接调用了 base 属性。

失败后，我定义了一个名为 DocumentText 的全新属性。我让它包装了 base.Text，使用它定义了绑定(bind)，因此得到了绑定(bind)工作的一个方向。那就是从模型到控件。但根据我的发现，在另一个方向上进行绑定(bind)的最佳方法是 override OnTextChanged 事件(或等效事件)以使其引发属性更改通知.问题是控件没有这样的事件，听起来很奇怪。

现在我可能会重写一堆其他事件(例如 OnKeyUp、OnMouseClick 等)，这样我就可以处理所有可能修改文本的操作(键入、拖放、粘贴等)，但那样做似乎不太实用，并且可能无法重复我以后可能有兴趣绑定(bind)的其他属性。在我有空的时候在网上搜索了几天之后，我仍然没有找到其他想法。那么，除了深入研究控件本身的代码之外，我的问题是否有任何适当的解决方案？(据推测，许可证将使我能够访问源代码，但我宁愿避免对其进行直接修改)。

我避免在问题标题和标签中指定 QWhale 编辑器，因为我觉得我正在寻找的内容不依赖于这个特定的控件。如果我错了，请纠正我。

由于在不同的计算机上，我目前无法提供我的测试代码，但如果您认为有必要，请给我留言，我会添加。

---

更新:这是代码，因为我不确定我是否能够清楚地描述我的问题。

class ExtenEdit : TextEditor
{
    public static DependencyProperty TextProperty =
        DependencyProperty.Register("Text", typeof(string), typeof(ExtenEdit),
            new PropertyMetadata((obj, args) =>
            {
                TextEditor target = (TextEditor)obj;
                target.DocumentText = (string)args.NewValue;
            })
        );

    public new string Text
    {
        get { return base.Text; }
        set
        {
            if (base.Text != value)
            {
                base.Text = value;
            }
        }
    }
}

这在我修改 ViewModel 中的值时有效，但在编辑器中键入时，我的属性被绕过并直接调用基本属性。如果我添加这样的东西，它会起作用:

protected override void OnKeyUp(System.Windows.Input.KeyEventArgs e)
{
    SetCurrentValue(TextProperty, base.Text);
    base.OnKeyUp(e);
}

但正如我上面所说，我不能将其视为有效的“干净”解决方案。

下面是我的 XAML 中的相关部分(您会注意到我也在玩 AvalonDock):

命名空间:

<Window x:Class="AvalonDockQWhale.MainWindow"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:avalonDock="http://avalondock.codeplex.com"
    xmlns:converter="clr-namespace:AvalonDockQWhale.Converter"
    xmlns:pane="clr-namespace:AvalonDockQWhale.View.Pane"
    xmlns:editor="clr-namespace:QWhale.Editor.Wpf;assembly=QWhale.Editor.Wpf"
    xmlns:control="clr-namespace:AvalonDockQWhale.Control"
    xmlns:controlHelper="clr-namespace:AvalonDockQWhale.ControlHelper"
    x:Name="mainWindow"
    Title="MainWindow" Height="600" Width="800">

以及我最初尝试的绑定(bind):

<control:ExtenEdit Text="{Binding Path=ScriptText, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}" />

我为 DHN 的解决方案尝试过的绑定(bind):

<editor:TextEditor controlHelper:AttachedProperties.Text="{Binding ScriptText}" />

和

<editor:TextEditor controlHelper:AttachedProperties.Text="{Binding Path=ScriptText, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}" />

---

最终细节:我已经接受了 DHN 给出的答案，尽管它在我的具体情况下不起作用，因为它似乎是解决类似问题的一个不错的解决方案。

Answer 1

Here是我昨天为了帮助另一个 SOler 而写的东西。但它也可能适合您的需求。我通过 DependencyProperty“扩展”了一个 Window，因此它的 DialogResult 属性是可绑定(bind)的。

开始

public class AttachedProperties : DependencyObject //adds a bindable DialogResult to window
{
    public static readonly DependencyProperty DialogResultProperty = 
        DependencyProperty.RegisterAttached("DialogResult", typeof(bool?), typeof(AttachedProperties), 
        new PropertyMetaData(default(bool?), OnDialogResultChanged));

    public bool? DialogResult
    {
        get { return (bool?)GetValue(DialogResultProperty); }
        set { SetValue(DialogResultProperty, value); }
    }

    private static void OnDialogResultChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        var window = d as Window;
        if (window == null)
            return;

        window.DialogResult = (bool?)e.NewValue;
    }
}

现在您可以将 DialogResult 绑定(bind)到 VM 并设置其属性值。设置值后，窗口将关闭。

<!-- Assuming that the VM is bound to the DataContext and the bound VM has a property DialogResult -->
<Window someNs:AttachedProperties.DialogResult={Binding DialogResult} />

结束

恕我直言，如果您只需要一个特定属性，这是提供可绑定(bind)性的好方法。如果有更多属性必须以这种方式改进，那么我会扩展或包装该类。

编辑 - 这是我们生产环境中运行的内容的摘要

<Window x:Class="AC.Frontend.Controls.DialogControl.Dialog"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:DialogControl="clr-namespace:AC.Frontend.Controls.DialogControl" 
        xmlns:hlp="clr-namespace:AC.Frontend.Helper"
        MinHeight="150" MinWidth="300" ResizeMode="NoResize" SizeToContent="WidthAndHeight"
        WindowStartupLocation="CenterScreen" Title="{Binding Title}"
        hlp:AttachedProperties.DialogResult="{Binding DialogResult}" WindowStyle="ToolWindow" ShowInTaskbar="True"
        Language="{Binding UiCulture, Source={StaticResource Strings}}">
        <!-- A lot more stuff here -->
</Window>

如您所见，我先声明命名空间 xmlns:hlp="clr-namespace:AC.Frontend.Helper"，然后再声明绑定(bind) hlp:AttachedProperties.DialogResult= “{绑定(bind) DialogResult}”。

AttachedProperty 看起来像这样。这与我之前发布的不一样，但恕我直言，这应该没有任何区别。

public class AttachedProperties
{
    #region DialogResult

    public static readonly DependencyProperty DialogResultProperty =
        DependencyProperty.RegisterAttached("DialogResult", typeof (bool?), typeof (AttachedProperties), new PropertyMetadata(default(bool?), OnDialogResultChanged));

    private static void OnDialogResultChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        var wnd = d as Window;
        if (wnd == null)
            return;

        wnd.DialogResult = (bool?) e.NewValue;
    }

    public static bool? GetDialogResult(DependencyObject dp)
    {
        if (dp == null) throw new ArgumentNullException("dp");

        return (bool?)dp.GetValue(DialogResultProperty);
    }

    public static void SetDialogResult(DependencyObject dp, object value)
    {
        if (dp == null) throw new ArgumentNullException("dp");

        dp.SetValue(DialogResultProperty, value);
    }

    #endregion
}