集合属性的持久化——用集合编辑器编辑集合属性并自动生成代码

最新推荐文章于 2023-07-27 11:20:00 发布

原创最新推荐文章于 2023-07-27 11:20:00 发布 · 6.7k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#服务器 #winform #浏览器 #asp.net #behavior #xml

本文介绍了在控件开发中遇到的集合属性持久化问题，当在WinForm窗体上编辑TableLayoutPanel的集合属性FirmControl后，运行时发现未保存添加的项。原因是缺少了[DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]特性，该特性决定属性内容是否序列化。同时，集合属性必须实现IList或CollectionBase。文章还列举了其他设计时属性，如Bindable、Browsable、Category、Description等的相关特性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

今天在进行控件开发的时候，遇到了一个棘手的问题，问题描述如下：

public class CoreTableLayoutPanel : TableLayoutPanel

{

private List<ControlBoxItem> _firmControl=new List<ControlBoxItem>();

[Browsable(true)]

[Description("设定不可移动的控件集合")]

public List<ControlBox> FirmControl// ControlBox为一实体类，此处为显示

{

get

{

return this._firmControl;

}

….

…..

}

该控件继承自TableLayoutPanel，根据实际需要，在控件中定义了一个名为FirmControl的集合属性，控件进行编写完成后，被放到一个WinForm窗体上，找到该控件的FirmControl属性，然后对其进行添加项的操作，如下所示：

添加完以后，点击确定按钮。本以为添加成功了，然后开始运行程序，程序运行效果和预期的不一样，然后对程序进行跟踪，发现FirmControl的Count属性竟然为0，奇怪？究竟是什么原因呢？我再次打开如上图所示的“集合编辑器界面”，看到数据项明明已经添加上，可是为什么Count会为0呢？然后我去看窗体设计器生成的代码，竟然没有找到形如this.coreTableLayoutPanel1.FirmControl.Add(…);的代码，看来虽然在“集合编辑器”中显示已经添加上了，但这其实只是一种假象，我把WinForm工程关掉再重新打开，再次打开集合编辑器，竟然为空了！！！这是什么原因呢？

在网上翻了半天终于找到原因了，对于集合属性（Property），需要为其添加[DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]特性（Attribute），该特性指定属性是否以及如何在代码中序列化，其值为DesignerSerializationVisibility的枚举值。有3种设置方式：

DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)指定序列化程序不应该序列化属性值；

DesignerSerializationVisibility(Design erSerializationVisibility.Visible)指定应该允许序列化程序序列化属性的值；

DesignerSerializationVisibility(DesignerSerializationVisibility.Content)指定序列化程序应该序列化属性的内容，而不是属性本身。此字段为只读，Visible为其默认值。只有指定了改特性后，点击“集合编辑器”的确定按钮后，VS.studio才能生成相应的添加代码（即对属性进行序列化）。

除此之外，还有一点需要注意的是，集合属性必须为实现IList或CollectionBase的类型。

下面是在进行控件设计时，属性常用的的一些特性：

System.Windows.Forms 命名空间中的有

Bindable
这个特性表示属性是否可以绑定一个有效数据源。通常使用布尔值进行设置。例如：Bindable(true)。如果使用值true标记属性，表示该属性可以绑定一个有效数据源，且应引发该属性的属性更改通知。
Browsable
指定属性是否应该在属性浏览器中显示，使用布尔值设置。通常情况下，功用属性和那些希望在属性浏览器中显示的属性被设置为 Browsable(true)，只读属性和那些不希望在属性浏览器中见到的属性被设置为 Browsable(false)。
Category
指定属性在属性浏览器中进行分组显示的类别。该设计时特性帮助可视化编辑器将属性进行逻辑分组。通常分为：外观（Appearance）、行为（Behavior）、布局（Layout）、数据（Data）、操作（Action）、键盘（Key）和鼠标（Mouse）等。除此之外，还可以自定义分组类别。
Description
指定显示在属性浏览器下方，属性的文字说明。
DesignerSerializationVisibility
指定属性是否以及如何在代码中序列化，其值为DesignerSerializationVisibility的枚举值。存在3种设置方式：DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)指定序列化程序不应该序列化属性值；DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)指定应该允许序列化程序序列化属性的值；
DesignerSerializationVisibility(DesignerSerializationVisibility.Content)指定序列化程序应该序列化属性的内容，而不是属性本身。此字段为只读。.Visible为其默认值。
NotifyParentProperty
指示当此特性应用到的属性的值被修改时将通知其父属性。换言之，如果属性的父属性应该在该属性值改改时接到通知，则向该属性应用NotifyParentProperty特性。通常使用布尔值进行设置。

System.Web.UI命名空间的有（Asp.net服务器控件专用）
ParseChildren
使用该特性指示当在页面上以声明方式使用控件时，嵌套在服务器控件标记内的XML元素是应该视为属性还是应视为子控件。通常情况下，包含两种声明方式：①ParseChildren(true)表示将子XML元素作为服务器控件的子控件分析；②ParseChildren(bool childrenasProperty, string defaultProperty)，其中childrenasProperty和方式①中的布尔值参数意义相同，defaultProperty定义默认情况下将子控件分析为服务器控件的集合属性。
PersistChildren
该特性指示设计时是否应将服务器控件的子控件作为内部嵌套控件保持。如果该特性为PersistChildren(true)，则将服务器控件的子控件作为嵌套服务器控件标记保持。如果为PersistChildren(false)，则将该控件的属性作为嵌套元素保持。
PersistenceMode
指定如何将服务器控件属性或事件保持到ASP.NET页面的元数据属性。共存在4种枚举设置方式：①PersistenceMode(PersistenceMode.Attribute)，指定属性或事件保持为特性；②PersistenceMode(PersistenceMode.EncodedInnerDefaultProperty)，指定属性作为服务器控件的唯一内部文本而属性值是HTML编码的，只能对字符串作这种指定；③PersistenceMode(PersistenceMode.InnerDefaultProperty)，指定属性在服务器控件中保持为内部文本，还指示将该属性定义为元素的默认属性，只能指定一个属性为默认属性；④PersistenceMode(PersistenceMode.InnerProperty)，指定属性在服务器控件中保持为嵌套标记，这通常用于复杂对象，它们具有自己的持久性属性。
DefaultProperty
指定服务器控件的默认属性，例如[DefaultProperty("MyProperty")]。
TypeConverter
指定用做此特性所绑定到的对象的转换器的类型。用于转换的类必须从TypeConverter继承。使用ConverterTypeName属性来获取为该特性所绑定到的对象提供数据转换的类名。