扩展WPF第三方控件以启用对现有属性的双向绑定

时间:2013-04-23 22:40:23

标签: c# wpf mvvm binding custom-controls

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

由于某些更高级别的决策不受我的控制,用户界面将使用WPF开发,Quantum Whale Editor.NET控件将用作编辑器。遗憾的是,似乎QWhale Editor.NET的WPF版本仍然没有完全成熟,因此缺少文档,最糟糕的是,它似乎没有绑定友好。

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

  

无法在“TextEditor”类型的“Text”属性上设置“绑定”。 '绑定'只能在DependencyObject的DependencyProperty上设置。

在检查替代方案时尝试了AvalonEdit,我记得这个其他Stack Overflow问题:Making AvalonEdit MVVM Compatible。所以我遵循了相同的概念。

我已经定义了一个继承自编辑器的类,添加了一个依赖项属性,并且首先尝试将它与使用Text隐藏编辑器的原始new属性相结合。但显然这是一个很长的镜头而我的财产没有被使用,基本属性被直接调用。

一旦失败,我定义了一个名为DocumentText的全新属性。我让它包裹base.Text,使用它定义了绑定,因此得到了一个绑定方向。那是从模型到控制。但是从我发现的情况来看,让绑定在另一个方向上工作的最好方法是override OnTextChanged事件(或等效事件)让它引发属性更改通知。问题是控件没有这样的事件,听起来很奇怪。

现在我可以覆盖一堆其他事件(例如OnKeyUp,OnMouseClick等),以便我可以处理所有可能修改文本的操作(打字,拖放,粘贴等)但是对于我以后可能感兴趣的其他属性来说,它似乎不太实用,可能无法重复。在我找到时间在网上搜索了几天之后,我仍然没有找到其他想法。那么,如果没有深入探讨控件本身的代码,我的问题是否有适当的解决方案? (据说,许可证将允许我访问源代码,但我宁愿避免直接修改它。)

我避免在问题标题和标签中指定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">

我最初尝试的绑定:

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

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

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

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

最终细节: 我接受了DHN给出的答案,即使它在我的具体情况下不起作用,因为它似乎是解决类似问题的合适解决方案。

1 个答案:

答案 0 :(得分:1)

Here是我昨天写的,是为了帮助另一个SOler。但它也可能适合您的需求。我通过Window“扩展”了DependencyProperty,以便其DialogResult属性可绑定。

<强>开始

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绑定到VM并设置其属性值。设置值后,窗口将关闭。

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

<强>结束

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

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

<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",然后声明绑定hlp:AttachedProperties.DialogResult="{Binding 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
}