c# - 将 DataSource 属性添加到自定义 WinForms 控件

Question

我想向我的自定义 winforms 控件添加复杂的数据绑定(bind)，因此我可以执行以下操作:

myControl.DisplayMember = "Name";
myControl.ValueMember = "Name";
myControl.DataSource = new List<someObject>();

有谁知道要实现这个需要实现什么接口(interface)等？

我查看了一下，发现只有 IBindableComponent，但这似乎是针对简单绑定(bind)而不是复杂绑定(bind)。

Answer 1

根据您需要的数据绑定(bind)类型，将以下属性之一应用于您的自定义控件:

• 对于复杂数据绑定(bind): ComplexBindingPropertiesAttribute
• 用于查找数据绑定(bind): LookupBindingPropertiesAttribute

(这个问题特别提到了复杂数据绑定(bind)，但给定的代码示例对我来说看起来像lookup数据绑定(bind)，所以我将两者都包括在内。)

有关示例实现，请查看 .NET Framework source code :

• ComplexBindindPropertiesAttribute在 DataGridView 中实现
• LookupBindingPropertiesAttribute在 ListControl 中实现

---

但这些实现对我来说看起来非常复杂，因此在您自己的自定义控件中嵌入现有控件(例如 DataGridView、ListBox 或 ComboBox)可能更容易，以利用其现有数据绑定(bind)实现，而不是自己编写。 (如有必要，您可以使嵌入式控件不可见。)这是 Microsoft 在以下指南中演示的方法:

• Create a Windows Forms user control that supports complex data binding
• Create a Windows Forms user control that supports lookup data binding

在这些指南中，他们创建了一个数据源来将自定义控件绑定(bind)到外部数据库，但看起来您只是想将自定义控件绑定(bind)到一个内部集合，例如 List<T>。 .在这种情况下，下面的改编代码可能适合您。

---

在 Visual Studio 的 Windows 窗体项目中，添加一个新的 UserControl .

对于复杂数据绑定(bind)，应用ComplexBindingPropertiesAttribute到自定义控件。添加 DataGridView控制它。添加DataSource和 DataMember属性，并将它们挂接到 DataGridView自己的属性。

// ComplexBindingControl.cs
// Adapted from https://learn.microsoft.com/visualstudio/data-tools/create-a-windows-forms-user-control-that-supports-complex-data-binding

using System.ComponentModel;
using System.Windows.Forms;

namespace BindingDemo
{
    [ComplexBindingProperties("DataSource", "DataMember")]
    public partial class ComplexBindingControl : UserControl
    {
        public ComplexBindingControl()
        {
            InitializeComponent();
        }

        // Use a DataGridView for its complex data binding implementation.

        public object DataSource
        {
            get => dataGridView1.DataSource;
            set => dataGridView1.DataSource = value;
        }

        public string DataMember
        {
            get => dataGridView1.DataMember;
            set => dataGridView1.DataMember = value;
        }
    }
}

对于查找 数据绑定(bind)，应用 LookupBindingPropertiesAttribute到自定义控件。添加 ListBox或 ComboBox控制它。添加DataSource , DisplayMember , ValueMember和 LookupMember属性，并将它们挂接到 ListBox的或ComboBox自己的属性。

// LookupBindingControl.cs
// Adapted from https://learn.microsoft.com/visualstudio/data-tools/create-a-windows-forms-user-control-that-supports-lookup-data-binding

using System.ComponentModel;
using System.Windows.Forms;

namespace BindingDemo
{
    [LookupBindingProperties("DataSource", "DisplayMember", "ValueMember", "LookupMember")]
    public partial class LookupBindingControl : UserControl
    {
        public LookupBindingControl()
        {
            InitializeComponent();
        }

        // Use a ListBox or ComboBox for its lookup data binding implementation.

        public object DataSource
        {
            get => listBox1.DataSource;
            set => listBox1.DataSource = value;
        }

        public string DisplayMember
        {
            get => listBox1.DisplayMember;
            set => listBox1.DisplayMember = value;
        }

        public string ValueMember
        {
            get => listBox1.ValueMember;
            set => listBox1.ValueMember = value;
        }

        public string LookupMember
        {
            get => listBox1.SelectedValue?.ToString();
            set => listBox1.SelectedValue = value;
        }
    }
}

(编辑:感谢 Frank's answer 提醒我 listBox1.SelectedValue 可能是 null。)

要对其进行测试，请在 Visual Studio 中构建项目，然后将自定义控件的实例添加到 Form .创建一些示例数据，并使用其相关属性将其绑定(bind)到自定义控件。

// Form1.cs

using System.Collections.Generic;
using System.Windows.Forms;

namespace BindingDemo
{
    public partial class Form1 : Form
    {
        private readonly List<SomeObject> data;

        public Form1()
        {
            InitializeComponent();

            // Prepare some sample data.
            data = new List<SomeObject>
            {
                new SomeObject("Alice"),
                new SomeObject("Bob"),
                new SomeObject("Carol"),
            };

            // Bind the data to your custom control...

            // ...for "complex" data binding:
            complexBindingControl1.DataSource = data;

            // ...for "lookup" data binding:
            lookupBindingControl1.DataSource = data;
            lookupBindingControl1.DisplayMember = "Name";
            lookupBindingControl1.ValueMember = "Name";
        }
    }

    internal class SomeObject
    {
        public SomeObject(string name)
        {
            Name = name;
        }

        public string Name { get; set; }
    }
}