在 UserControl 中使用 BindingSource

Question

我有一个包含多个字段的 UserControl，我希望将其绑定到 BindingSource。 我还希望 UserControl 公开一些 BindingSource 属性，以便可以将其放在表单上并绑定到表单上的 BindingSource。 是否有捷径可寻？ 我意识到我可以在其 BindSource setter 中重新绑定 UserControl 的所有控件。 但这似乎是错误的。 是否有一些 BindingSource 代理可以让我将用户控件中的 BindingSource 链接到表单中的 BindingSource？

Answer 1

根据你的问题，我很难理解你想要做什么。 因此，我希望我会尽力为您提供有关此事的有趣信息。

首先，让我们考虑客户管理软件项目中的以下 UserControl。

public partial class CustomerManagementUserControl : UserControl {
    public CustomerManagementUserControl() {
        InitializeComponent();
        _customerBindingSource = new BindingSource();
    }
    public IList<ICustomer> DataSource {
        set {
            _customerBindingSource.DataSource = value;
        }
    }
    private BindingSource _customerBindingSource;
}

其次，让我们考虑以下表格，它应该是您的客户管理表格。

public partial class CustomerManagementForm : Form {
    public CustomerManagementForm() {
        InitializeComponent();
        _customerUserControl = new CustomerManagementUserControl();
        _customerUserControl.Name = @"customerUserControl";
    }
    private void CustomerManagementForm_Load(object sender, EventArgs e) {
        // CustomersFacade is simply a static class providing customer management features and requirements.
        // Indeed, the GetCustomers() method shall return an IList<ICustomer>.
        // The IList type and typed IList<T> are both intended to be bindable as a DataSource for DataBinding.
        _customerUserControl.DataSource = CustomersFacade.GetCustomers();
        this.Controls.Add(_customerUserControl);
    }
    private CustomerManagementUserControl _customerUserControl;
}

如果您希望在“属性”窗口中使用 CustomerManagementUserControl.DataSource 属性，请考虑在属性定义的顶部添加以下内容。

[System.ComponentModel.DesignTimeVisible(true), System.ComponentModel.DesignerCategory("CustomerUserControl"), System.ComponentModel.Description("Sets the CustomerUserControl DataSource property")]

这是做我想你可能想做的事情的一种方式。 另一方面，如果您希望通过将不同类型的对象设置为 UserControl.BindingSource.DataSource 属性来获得尽可能最抽象的内容，那么您将必须编写一个可以检测类型的方法传递对象，然后相应地绑定属性。 如果您愿意使用反射，也许您可​​以采用的一个好方法是使用它。 您可以想象以任何可能的方式使用此类多态性功能，您将必须自己编写一个所有可绑定对象都必须实现的接口。 这样，您将避免未知的属性名称，并且当需要绑定 UserControl 的控件时，您将能够将正确的属性绑定到正确的控件，依此类推。

让我们尝试以下操作：

public interface IEntity {
    double Id { get; set; }
    string Number { get; set; }
    string Firstname { get; set; }
    string Surname { get; set; }
    long PhoneNumber { get; set; }
}
public interface ICustomer : IEntity {
}
public interface ISupplier : IEntity {
    string Term { get; set; }
}
public sealed Customer : ICustomer {
    public Customer() {
    }
    public double Id { get; set; }
    public string Number { get; set; }
    public string Firstname { get; set; }
    public string Surname { get; set; }
    public long PhoneNumber { get; set; }    
}
public sealed Supplier : ISupplier {
    public Supplier() {
    }
    public double Id { get; set; }
    public string Number { get; set; }
    public string Firstname { get; set; }
    public string Surname { get; set; }
    public long PhoneNumber { get; set; }    
    public string Term { get; set; }
}

考虑到上面的代码，您可以使用 UserControl 的 DataSource 属性与 IEntity 绑定，因此您的属性可能像这样。

[System.ComponentModel.DesignTimeVisible(true), System.ComponentModel.DesignerCategory("CustomerUserControl"), System.ComponentModel.Description("Sets the CustomerUserControl DataSource property")]
public IList<IEntity> DataSource {
    set {
        _customerBindingSource.DataSource = value;
    }
}

也就是说，如果您希望更进一步，您可以公开 UserControl 的控件 DataBindings 属性，以便在设计时设置它们。 考虑到这一点，您将希望将 BindingSource 公开为公共属性，以便您也可以在设计时设置它，然后从此 BindinSource 选择您的 DataMember。

我希望这对您有一点帮助，或者至少为您提供一些进一步搜索的线索。

Answer 2

我知道这是一个迟到的答复； 但是，对于阅读这篇文章的其他人来说可能会有用。

我在 UserControl 上有数据绑定的控件。 我需要在 UserControl 上有一个 BindingSource ，以便能够在设计时绑定控件。 然而，“真正的”BindingSource 位于Form 上。 换句话说，UserControl 上的控件的行为应该就像它们直接位于表单上（或位于表单上的 ContainerControl 上）一样。

此解决方案背后的想法是监视“真实”BindingSource 的 DataSourceChanged 事件，并将其 DataSource 分配给本地 BindingSource 当它改变时。 为了找到“真正的”BindingSource，我让包含它的 Form（或 Control）实现以下接口：

public interface IDataBound
{
    BindingSource BindingSource { get; }
}

我们可以观察控件的 ParentChanged 事件，以便了解何时将其添加到 Form 或 ContainerControl。 这里的问题是，此 ContainerControl 本身此时可能尚未添加到 Form（或另一个 ContainerControl）中。 在本例中，我们订阅在父级链中找到的最后一个父级的 ParentChanged 事件，并等待添加最后一个父级，依此类推，直到找到 Control code> 或 Form 实现 IDataBound。 当找到 IDataBound 时，我们订阅其 BindingSource 的 DataSourceChanged 事件。

public partial class MyUserControl : UserControl
{
    private IDataBound _dataBoundControl;
    private Control _parent;

    public MyUserControl()
    {
        InitializeComponent();
        if (LicenseManager.UsageMode == LicenseUsageMode.Runtime) {
            _parent = this;
            SearchBindingSource();
        }
    }

    private void SearchBindingSource()
    {
        if (_parent != null && _dataBoundControl == null) {
            while (_parent.Parent != null) {
                _parent = _parent.Parent;
                _dataBoundControl = _parent as IDataBound;
                if (_dataBoundControl != null) {
                    if (_dataBoundControl.BindingSource != null) {
                        _dataBoundControl.BindingSource.DataSourceChanged +=
                            new EventHandler(DataBoundControl_DataSourceChanged);
                    }
                    return;
                }
            }
            // This control or one of its parents has not yet been added to a
            // container. Watch for its ParentChanged event.
            _parent.ParentChanged += new EventHandler(Parent_ParentChanged);
        }
    }

    void Parent_ParentChanged(object sender, EventArgs e)
    {
        SearchBindingSource();
    }

    void DataBoundControl_DataSourceChanged(object sender, EventArgs e)
    {
        localBindingSource.DataSource = _dataBoundControl.BindingSource.DataSource;
    }
}

Answer 3

如果您想自动完成这一切，您可以在用户控件的加载事件或类似的事件中从父表单中查找绑定源...

Dim components As Reflection.FieldInfo = typ.GetField("components", Reflection.BindingFlags.DeclaredOnly Or Reflection.BindingFlags.Instance Or Reflection.BindingFlags.NonPublic)

Dim lstBindingSources As New List(Of BindingSource)
For Each obj As Object In components.Components
   Dim bindSource As BindingSource = TryCast(obj, BindingSource)
   If bindSource IsNot Nothing Then
      lstBindingSources.Add(bindSource)
   End If
Next
If lstBindingSources.Count = 1 Then
   MyBindingSource.DataSource = lstBindingSources(0).DataSource
End If

Answer 4

如果您在两个绑定源上分配与数据源相同的对象引用，则控件将不会在第二个绑定源上一致更新。 可能，对上述选择的折衷方案如下：

1. 暂时向用户控件添加绑定源，并使用 VS 设计器设置控件的绑定。
2. 在代码编辑器中调出designer.vb。 搜索设计器创建的所有“DataBindings.Add”行。 将它们全部复制到记事本中。
3. 从设计器中删除绑定源并在代码中添加绑定源引用。 为绑定源添加一个属性，其名称与设计器中使用的名称相同。 在属性的 setter 中，粘贴上面步骤 2 中记事本中的所有行。
4. 在窗体的 Load 事件中，将窗体的绑定源分配给用户控件上的属性。 如果用户控件嵌入到另一个用户控件中，则可以使用父控件的handlecreated事件来执行相同的操作。

由于 VS 设计器正在创建所有这些文字文本属性名称，因此可以减少打字次数和拼写错误。

Answer 5

此讨论对于发现将登录模型绑定到自定义 UserControl 以在 WinForms 窗口上输入密码的替代方法很有用。 特别有趣的是@Olivier 的帖子实现了 IDataBound 接口。 虽然登录模型的简单性可能有点过分，但我想测试其有效性。 公开一个属性以从自定义密码框返回密码将非常简单明了。 我不知道利用这一财产有多么容易。 正如@WillMarcouiller 评论的那样，可以在password_box 上公开BindingSource 控件。

最后，结果是按照 @DavidWilks 的建议，仅在绑定数据源更改的事件处理程序中包含将 TextBox 与 BindingSource 绑定的步骤。

void DataBoundControl_DataSourceChanged(object sender, EventArgs e)
{
    localBindingSource.DataSource = _dataBoundControl.BindingSource.DataSource;
    textBox1.DataBindings.Add(new Binding("Text", localBindingSource, "Password", false));
}

此示例没有解决表单上 UserControl 的多个实例。 目前，我认为最简单的解决方案是在控件中创建一个属性，以将源名称分配给可以在设计器中处理的源名称。 至少在 VS2022 中，有一个杂项部分接收 UserControl 公开的属性。