c# - 如何使用 WinForms 数据绑定(bind)正确触发 UserControl 中值的更改？

Question

我在我的 WinForms 应用程序中创建了两个 UserControl。一个包含一个 TextBox(我们暂时称它为 TextEntryControl)，另一个应该使用我在这个 TextBox 中输入的值来执行内部操作(启用一个按钮并在单击此按钮时使用该值)- 我们称其为 TextUsingControl。

但是，我无法通过 DataBinding 做到这一点。

第一种(天真的)方法

我向 TextEntryControl 添加了一个 string 属性，如下所示:

public string MyStringProperty { get; set; }

然后我使用 UI 设计器将 TextBox 的 Text 属性绑定(bind)到此 MyStringProperty，从而生成 textEntryControlBindingSource。我在 InitializeComponents() 后面的构造函数中添加了:

textEntryControlBindingSource.Add(this);

我将相同的属性添加到 TextUsingControl，并且在我使用这两个控件的外部 UI 中，我将 TextUsingControl 的字符串属性绑定(bind)到其中一个TextEntryControl，并适当更新绑定(bind)源:

textEntryControlBindingSource.Add(textEntryControl1);

我在 TabControl 的不同选项卡上使用这两个控件，并且该机制只工作一次，当我首先在文本框中输入文本然后切换到另一个控件时。

下次尝试

我为字符串创建了一个简单的包装器类:

public sealed class StringWrapper {

    public string Content { get; set; }
}

在我的文本输入控件中，我将文本框绑定(bind)到这个字符串包装器，并将属性更改为如下所示:

public string MyStringProperty {
    get {
        return _stringWrapper.Content;
    }
    set {
        _stringWrapper.Content = value;
    }
}

我在外部控件中使用 TabControl 做了类似的事情 - 使用 StringWrapper 将两个用户控件的 MyStringProperty 绑定(bind)到。

结果:相同。但这是合乎逻辑的，因为委托(delegate)给包装器的外部属性不会得到通知。

第三次尝试

这个在某种程度上是可行的，但我认为这是一个丑陋的解决方法。

我完全放弃了 MyStringProperty 并通过一个属性传入包装器对象本身，该属性再次将其传递给绑定(bind)源:

public StringWrapper MyStringWrapper {
    get {
        return stringWrapperBindingSource.Cast<StringWrapper>().FirstOrDefault();
    }
    set {
        stringWrapperBindingSource.Clear();
        if(value != null) stringWrapperBindingSource.Add(value);
    }
}

现在我只创建一个 StringWrapper 对象，并在 InitializeComponent() 之后立即将其设置为两个用户控件。

INotifyPropertyChanged

作为后续行动:我尝试了 INotifyPropertyChanged 以及描述的 on MSDN.这也没有帮助。

我想要实现的目标

我希望两个用户控件都有一个 MyStringProperty，当我在 TextEntryControl 的文本框中输入的文本发生变化时，该属性应该更新并正确地通知任何绑定(bind)它所附加的来源。 TextUsingControl 应在其属性更改时自行更新。

后半部分很简单，我只是将适当的逻辑添加到属性的 set 部分，但我在处理第一个部分时遇到了问题。

我习惯了 Eclipse 的 JFace 数据绑定(bind)，其中可以使用 PropertyChangeSupport 和 PropertyChangeListener 实现此功能 - 在这里，我只是将适当的事件触发代码添加到 setter 我可以在设置数据绑定(bind)时使用 BeanProperties.value()。

Answer 1

它是适当的属性实现和适当的数据绑定(bind)的组合。

(1) 属性实现:

属性不需要很复杂。它可以是您天真的方法中的简单类型，但重要的部分是它应该提供属性更改通知。您可以使用通用的 INotifyPropertyChanged 机制或 Windows 窗体特定的 PropertyNameChanged 命名事件模式。在这两种情况下，您都不能使用 C# auto property 功能，而必须手动实现它(使用显式支持字段)。这是一个示例实现:

string myStringProperty;
public string MyStringProperty
{
    get { return myStringProperty; }
    set
    {
        if (myStringProperty == value) return;
        myStringProperty = value;
        var handler = MyStringPropertyChanged;
        if (handler != null) handler(this, EventArgs.Empty);
    }
}

public event EventHandler MyStringPropertyChanged;

(2)数据绑定(bind):

将单个控件属性绑定(bind)到单个对象属性称为简单数据绑定(bind)，通过 Control.DataBindings 实现。 .你可以看看ControlBindingsCollection.Add方法/Binding Constructor重载和 Binding类属性/方法/事件以获取更多信息。

Binding 所做的基本上是在源对象属性和目标对象属性之间创建链接(一种或两种方式)。请注意属性这个词——这正是开箱即用的支持。但是使用以下简单的辅助方法(在我对 How to set Textbox.Enabled from false to true on TextChange? 的回答中提出)，您可以轻松地创建像绑定(bind)这样的单向表达式:

public static void Bind(this Control target, string targetProperty, object source, string sourceProperty, Func<object, object> expression)
{
    var binding = new Binding(targetProperty, source, sourceProperty, true, DataSourceUpdateMode.Never);
    binding.Format += (sender, e) => e.Value = expression(e.Value);
    target.DataBindings.Add(binding);
}

这是一个完整的工作演示:

using System;
using System.Windows.Forms;

namespace Samples
{
    static class Program
    {
        [STAThread]
        static void Main()
        {
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            var form = new Form();
            var splitView = new SplitContainer { Dock = DockStyle.Fill, Parent = form };
            var textEntry = new TextEntryControl { Dock = DockStyle.Fill, Parent = splitView.Panel1 };
            var textConsumer = new TextConsumingControl { Dock = DockStyle.Fill, Parent = splitView.Panel2 };
            textConsumer.DataBindings.Add("MyStringProperty", textEntry, "MyStringProperty", true, DataSourceUpdateMode.Never);
            Application.Run(form);
        }
    }

    class TextEntryControl : UserControl
    {
        TextBox textBox;
        public TextEntryControl()
        {
            textBox = new TextBox { Parent = this, Left = 16, Top = 16 };
            textBox.DataBindings.Add("Text", this, "MyStringProperty", true, DataSourceUpdateMode.OnPropertyChanged);
        }

        string myStringProperty;
        public string MyStringProperty
        {
            get { return myStringProperty; }
            set
            {
                if (myStringProperty == value) return;
                myStringProperty = value;
                var handler = MyStringPropertyChanged;
                if (handler != null) handler(this, EventArgs.Empty);
            }
        }

        public event EventHandler MyStringPropertyChanged;
    }

    class TextConsumingControl : UserControl
    {
        Button button;
        public TextConsumingControl()
        {
            button = new Button { Parent = this, Left = 16, Top = 16, Text = "Click Me" };
            button.Bind("Enabled", this, "MyStringProperty", value => !string.IsNullOrEmpty(value as string));
        }

        string myStringProperty;
        public string MyStringProperty
        {
            get { return myStringProperty; }
            set
            {
                if (myStringProperty == value) return;
                myStringProperty = value;
                var handler = MyStringPropertyChanged;
                if (handler != null) handler(this, EventArgs.Empty);
            }
        }

        public event EventHandler MyStringPropertyChanged;
    }

    public static class BindingUtils
    {
        public static void Bind(this Control target, string targetProperty, object source, string sourceProperty, Func<object, object> expression)
        {
            var binding = new Binding(targetProperty, source, sourceProperty, true, DataSourceUpdateMode.Never);
            binding.Format += (sender, e) => e.Value = expression(e.Value);
            target.DataBindings.Add(binding);
        }
    }
}

如您所见，textEntry 和 textConsumer 之间请求的(单向)绑定(bind)是通过这一行建立的:

textConsumer.DataBindings.Add("MyStringProperty", textEntry, "MyStringProperty", true, DataSourceUpdateMode.Never);

您可以在演示中看到的另一个有趣的地方是，如果您愿意，您实际上也可以数据绑定(bind)内部控件属性。 TextEntryControl 内部文本框和属性之间的整个同步是通过这一行实现的:

textBox.DataBindings.Add("Text", this, "MyStringProperty", true, DataSourceUpdateMode.OnPropertyChanged);

和 TextConsumingControl 内部按钮启用:

button.Bind("Enabled", this, "MyStringProperty", value => !string.IsNullOrEmpty(value as string));

当然，最后两件事是可选的，您可以在属性 setter 中执行此操作，但知道存在这样的选项真是太酷了。