C#自定义控件属性

时间:2022-08-31 08:24:18
自定义控件属性的特性:

Bindable
指定屬性是否支援Data Binding。
这个特性表示属性是否可以绑定一个有效数据源。通常使用布尔值进行设置。例如:Bindable(true)。如果使用值true标记属性,表示该属性可以绑定一个有效数据源,且应引发该属性的属性更改通知。

Browsable
控制屬性或事件是否顯示於屬性表。
指定属性是否应该在属性浏览器中显示,使用布尔值设置。通常情况下,功用属性和那些希望在属性浏览器中显示的属性被设置为 Browsable(true),只读属性和那些不希望在属性浏览器中见到的属性被设置为 Browsable(false)。

Category
對于屬性或是事件的分類,當屬性表採分類模式顯示時,會以此Attribute作為分類的依據。
指定属性在属性浏览器中进行分组显示的类别。该设计时特性帮助可视化编辑器将属性进行逻辑分组。通常分为:外观(Appearance)、行为(Behavior)、布局(Layout)、数据(Data)、操作(Action)、键盘(Key)和鼠标(Mouse)等。除此之外,还可以自定义分组类别。

Description
對于屬性或是事件的描述,當使用者選取該屬性或事件時,其會顯示於屬性表下方。
指定显示在属性浏览器下方,属性的文字说明。
EditorBrowsable 控制屬性或事件是否顯示於IntelliSense視窗中。Never不顯示,Always顯示, Advanced僅顯示於進階使用者模式,進階使用者模式可經由 Tools|  Options | TextEditor | C# 中開啟。

DesignerSerializationVisibility
指定属性是否以及如何在代码中序列化,其值为DesignerSerializationVisibility的枚举值。存在3种设置方式:DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)指定序列化程序不应该序列化属性值;DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)指定应该允许序列化程序序列化属性的值;
DesignerSerializationVisibility(DesignerSerializationVisibility.Content)指定序列化程序应该序列化属性的内容,而不是属性本身。此字段为只读。.Visible为其默认值。

NotifyParentProperty
指示当此特性应用到的属性的值被修改时将通知其父属性。换言之,如果属性的父属性应该在该属性值改改时接到通知,则向该属性应用NotifyParentProperty特性。通常使用布尔值进行设置。

除了需要熟悉以上设计时特性外,还有一些常用的设计时特性,这些特性声明于包含属性的类之前。通常情况下,它们应用于包含子属性的复杂属性的类的声明过程中,因此在声明复杂属性过程中意义重大,列举如下:
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")]。
DefaultEvent 指定預設的事件,當使用者於元件 / 控件上雙點滑鼠時,Editor會建立此事件函式。 ReadOnly 指定屬性是否唯讀。<true / false>

TypeConverter
指定用做此特性所绑定到的对象的转换器的类型。用于转换的类必须从TypeConverter继承。使用ConverterTypeName属性来获取为该特性所绑定到的对象提供数据转换的类名。
比如 :將控件的WITFieldName屬性顯示在“CSWIT”分組中,初始值為"",描述為“控件對應數據庫中字段的名稱”   [Bindable(true),
  Category("CSWIT"),
  DefaultValue("")
  Description("控件對應數據庫中字段的名稱。")]
  public string WITFieldName   
  {
          get
          {
                 return strFieldName;
          }
         set
         {
                strFieldName = value;
          }
  }