用户控件-自定义属性

我已经在Visual Studio（WinForms C＃）中开发了一个用户控件，并且有一个问题。

我需要我的用户控件的用户能够更改某些字符串值，并且我希望他们能够将用户控件添加到其窗体中，然后单击它以弹出“属性”窗格，其中我的用户控件的自定义属性将是显示。

如何为用户控件拥有自己的自定义属性？例如：

我的用户控件包含一个TextBox，我希望用户能够在设计时通过属性中名为“ Text”或“ Value”的属性来更改该TextBox的值。

c# winforms user-controls properties

— jay_t55
source

请参阅此处的文章-在C＃中创建自定义控件

— Pritam Zope

Answers:

108

您可以通过属性上的属性来执行此操作，如下所示：

[Description("Test text displayed in the textbox"),Category("Data")] 
public string Text {
  get => myInnerTextBox.Text;
  set => myInnerTextBox.Text = value;
}

类别是标题，在该标题下，属性将显示在Visual Studio属性框中。这是更完整的MSDN参考，包括类别列表。

— 尼克Craver
source

每当我想使用此代码生成项目时，无论我是否包含System.ComponentModel，VS2010都会崩溃：＆

— Grigory Kornilov 2013年

这适用于大多数自定义属性，但特别适用于覆盖Text属性（或我认为需要覆盖的任何其他属性）Hans在下面的回答将起作用

— derekantrican

这很简单，只需添加一个属性：

public string Value {
  get { return textBox1.Text; }
  set { textBox1.Text = value; }
}

使用Text属性有点棘手，UserControl类有意将其隐藏。您需要覆盖属性以使其恢复正常工作：

[Browsable(true), EditorBrowsable(EditorBrowsableState.Always), Bindable(true)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
public override string Text {
  get { return textBox1.Text; }
  set { textBox1.Text = value; }
}

— 汉斯·帕桑特
source

非常感谢！完全忘记了这一点，这让我发疯了想要回忆。

— 达米安

这应该是实际接受的答案。Text以特殊方式处理

— derekantrican

我真的不明白为什么也得到这么多的选票。编译器为此生成警告，可能大多数访问者会想出要坚持的警告new。通常这是一个非常糟糕的主意，但对于UC而言确实是偶然的。

— 汉斯·帕桑

@HansPassant我面临的唯一问题是，如果我使用与您拥有的代码相同的代码（用于Text属性），并在父控件的属性窗格中对其进行更改，则不会将代码添加到Form.Designer.cs，因此没有影响。设计器视图会更新，但是当我启动应用程序时，更改不存在

— derekantrican

哦，实际上，经过更多Google搜索之后，我才找到了解决方案：codeproject.com/Tips/403782/…。特别是为了覆盖Text属性，您还应该具有DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)要从设计器中保存更改的属性

— derekantrican

只需将公共属性添加到用户控件。

您可以添加[Category("MyCategory")]和[Description("A property that controls the wossname")]属性以使其更美观，但只要它是公共属性，它就应显示在属性面板中。

— 杰森·威廉姆斯
source