PropertyGrid自定义控件使用详解

标题：PropertyGrid自定义控件使用详解

简介

PropertyGrid 是 Windows 系统中提供的一个用于显示和编辑对象属性的控件。该控件提供了良好的可扩展性，我们可以通过自定义控件来实现需求，本文将详细讲解如何使用 PropertyGrid 自定义控件。

步骤说明

步骤一：新建自定义控件

开发环境为 Visual Studio 2019。

1. 在解决方案资源管理器中，右键单击项目，选择“添加”-“类”。

2. 在“名称”文本框中输入自定义控件的类名。

3. 勾选“从 User Control 派生”。

4. 单击添加按钮。

5. 在自定义控件的设计器中，以需要的方式添加控件。

步骤二：继承 UITypeEditor 和 TypeConverter 类

接下来我们需要继承 UITypeEditor 和 TypeConverter 类使 PropertyGrid 能够正常显示和编辑自定义控件。

public class CustomControlEditor : UITypeEditor
{
    public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context)
    {
        // 指定显示编辑器的样式
        return UITypeEditorEditStyle.DropDowm;
    }

    public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value)
    {
        // 显示自定义控件的窗口
        CustomControlDlg dlg = new CustomControlDlg(value as CustomControl);

        if (dlg.ShowDialog() == DialogResult.OK)
        {
            // 返回自定义控件的实例
            return dlg.CustomControl;
        }

        // 返回原值
        return value;
    }
}

public class CustomControlConverter : ExpandableObjectConverter
{
    public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType)
    {
        // 判断 destinationType 是否能够转换为字符串类型
        if (destinationType == typeof(string))
        {
            return true;
        }

        return base.CanConvertTo(context, destinationType);
    }

    public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)
    {
        // 如果 destinationType 能够转换为字符串类型，返回自定义控件的名称
        if (destinationType == typeof(string))
        {
            CustomControl customControl = value as CustomControl;
            if (customControl != null)
            {
                return customControl.Name;
            }
        }

        return base.ConvertTo(context, culture, value, destinationType);
    }
}

在上述代码中，CustomControlEditor 类指定了编辑器的样式，并且在 EditValue 函数中显示了自定义控件的窗口，返回该控件的实例。CustomControlConverter 类继承了 ExpandableObjectConverter，重载了 CanConvertTo 和 ConvertTo 函数，能够将自定义控件转换为字符串类型并在显示时正常显示。

步骤三：为属性添加自定义控件

设置步骤完成后，我们需要为一个属性关联自定义控件。

1. 在类的代码中定义需要关联的属性。

[Editor(typeof(CustomControlEditor), typeof(UITypeEditor))]
[TypeConverter(typeof(CustomControlConverter))]
public CustomControl CustomControlProperty { get; set; }

1. 在使用 PropertyGrid 的窗体中，设置该属性的默认值。

private void Form1_Load(object sender, EventArgs e)
{
    CustomControlControl customControl = new CustomControlControl();
    propertyGrid1.SelectedObject = new
    {
        CustomControlProperty = customControl
    };
}

实例说明

示例 1：自定义按钮

在下面的示例中，我们将在自定义控件中实现一个简单的按钮。

1. 在自定义控件中添加一个按钮。

2. 在自定义控件的代码中添加事件处理函数。

private void button1_Click(object sender, System.EventArgs e)
{
    // 在控制台输出
    Console.WriteLine("Clicked");
}

1. 在 CustomControlEditor 类的 EditValue 函数中，将自定义控件的窗口传递给自定义控件类（CustomControlControl），并订阅 ButtonClicked 事件。

CustomControlDlg dlg = new CustomControlDlg(value as CustomControlControl);
dlg.CustomControlControl.ButtonClicked += CustomControl_ButtonClicked;

private void CustomControl_ButtonClicked(object sender, EventArgs e)
{
    // 获取控件并调用按钮的事件处理函数
    (sender as CustomControlControl).button1.PerformClick();
}

1. 在自定义控件的 UserControl 中添加一个自定义事件，用于触发按钮事件。

public event EventHandler ButtonClicked;

1. 属性关联自定义控件。

[Editor(typeof(CustomControlEditor), typeof(UITypeEditor))]
[TypeConverter(typeof(CustomControlConverter))]
public CustomControlControl CustomControlProperty { get; set; }

1. 在使用 PropertyGrid 的窗体中，设置该属性的默认值。

private void Form1_Load(object sender, EventArgs e)
{
    propertyGrid1.SelectedObject = new
    {
        CustomControlProperty = new CustomControlControl()
    };
}

示例 2：自定义字典

在下面的示例中，我们将在自定义控件中实现一个简单的字典。

1. 在自定义控件中添加一个 TextBox 和一个 Button，并设置相应的事件处理函数。

private Dictionary<string, string> dictionary = new Dictionary<string, string>();

private void button1_Click(object sender, EventArgs e)
{
    // 添加键值对到字典中
    dictionary.Add(textBox1.Text, textBox2.Text);

    // 清空输入框
    textBox1.Text = "";
    textBox2.Text = "";

    // 刷新列表
    ListBox listBox = (ListBox)Controls["listBox1"];
    listBox.DataSource = dictionary.ToList();
    listBox.DisplayMember = "Key";
}

private void listBox1_SelectedIndexChanged(object sender, EventArgs e)
{
    // 根据当前选择更新文本框中内容
    ListBox listBox = sender as ListBox;
    if (listBox.SelectedIndex >= 0)
    {
        textBox1.Text = ((KeyValuePair<string, string>)listBox.SelectedItem).Key;
        textBox2.Text = ((KeyValuePair<string, string>)listBox.SelectedItem).Value;
    }
}

private void textBox_TextChanged(object sender, EventArgs e)
{
    // 更新字典中键值对
    ListBox listBox = (ListBox)Controls["listBox1"];

    KeyValuePair<string, string> selectedKeyValuePair = (KeyValuePair<string, string>)listBox.SelectedItem;
    int selectedIndex = listBox.SelectedIndex;

    if (selectedIndex >= 0)
    {
        string key = textBox1.Text;
        string value = textBox2.Text;
        dictionary.Remove(selectedKeyValuePair.Key);
        dictionary.Add(key, value);

        listBox.DataSource = dictionary.ToList();
        listBox.SelectedIndex = selectedIndex;
    }
}

1. 在 CustomControlEditor 类的 EditValue 函数中，将自定义控件的窗口传递给自定义控件类（CustomControlDict），设置 dictionary 的值，并进行数据绑定。

CustomControlDlg dlg = new CustomControlDlg(value as CustomControlDict);
CustomControlDict customControlDict = dlg.CustomControlDict;

foreach (KeyValuePair<string, string> kvp in customControlDict.dictionary)
{
    customControlDict.listBox.Items.Add(kvp);
}

customControlDict.bindingSource.DataSource = customControlDict.dictionary;
customControlDict.listBox.DataSource = customControlDict.bindingSource;
customControlDict.listBox.ValueMember = "Key";
customControlDict.listBox.SelectedIndexChanged += customControlDict.listBox1_SelectedIndexChanged;
customControlDict.keyTextBox.TextChanged += customControlDict.textBox_TextChanged;
customControlDict.valueTextBox.TextChanged += customControlDict.textBox_TextChanged;

if (dlg.ShowDialog() == DialogResult.OK)
{
    return customControlDict;
}

1. 在自定义控件的代码中，增加以下代码。

public Dictionary<string, string> dictionary = new Dictionary<string, string>();

private void okButton_Click(object sender, EventArgs e)
{
    Close(DialogResult.OK);
}

private void cancelButton_Click(object sender, EventArgs e)
{
    Close(DialogResult.Cancel);
}

1. 在自定义控件的代码中，添加一个 BindingSource 和一个 ListBox，并注册相应的事件处理函数。

public BindingSource bindingSource = new BindingSource();
public ListBox listBox = new ListBox();

public CustomControlDict()
{
    InitializeComponent();
    Controls.Add(listBox);

    listBox.Location = new Point(keyTextBox.Left, keyTextBox.Bottom + 10);
    listBox.Width = keyTextBox.Width + valueTextBox.Width + 1;
    listBox.Height = okButton.Top - listBox.Top - 10;
    listBox.Anchor = AnchorStyles.Left | AnchorStyles.Top | AnchorStyles.Bottom | AnchorStyles.Right;

    listBox.SelectedIndexChanged += listBox1_SelectedIndexChanged;

    bindingNavigator1.BindingSource = bindingSource;
    listBox.DisplayMember = "Key";
    listBox.ValueMember = "Value";

    Controls.Add(bindingNavigator1);
    bindingNavigator1.Location = new Point(keyTextBox.Left, listBox.Bottom + 10);

    bindingNavigator1.Visible = false;
}

private void listBox1_SelectedIndexChanged(object sender, EventArgs e)
{
    KeyValuePair<string, string> item = (KeyValuePair<string, string>)listBox.SelectedItem;
    keyTextBox.Text = item.Key;
    valueTextBox.Text = item.Value;
}

1. 属性关联自定义控件。

[Editor(typeof(CustomControlEditor), typeof(UITypeEditor))]
[TypeConverter(typeof(CustomControlConverter))]
public CustomControlDict CustomControlProperty { get; set; }

1. 在使用 PropertyGrid 的窗体中，设置该属性的默认值。

private void Form1_Load(object sender, EventArgs e)
{
    CustomControlDict customControlDict = new CustomControlDict();
    customControlDict.dictionary.Add("key1", "value1");
    customControlDict.dictionary.Add("key2", "value2");

    propertyGrid1.SelectedObject = new
    {
        CustomControlProperty = customControlDict
    };
}

结束语

在本文中，我们详细讲解了如何使用 PropertyGrid 自定义控件。通过实现自定义控件，我们可以更灵活地满足不同的需求。