ASP.NET 魔法學院

在伺服器控制項中常會使用到集合屬性，例如 ListBox.Items 屬性或 DropDownList.Items 屬性；若自訂的伺服器控制項也要加入集合屬性的話，最方便的方式就是繼承 CollectionBase 來撰寫集合類別，因為 CollectionBase 類別可序列化且支援設計階段的集合編輯器。

以下就來實作一個集合屬性的範例，我們要建立一個 TListItemCollection 集合類別，集合中包含 TListItem 成員類別。TListItem 類別中包含了 Text 及 Value 屬性，其中注意一點是要使用 <System.Serializable()> 將 TListItem 類別標記為可序列化。

Imports System.ComponentModel ''' <summary> ''' TListItem 類別。 ''' </summary> <System.Serializable()> _ Public Class TListItem Private FText As String = String.Empty Private FValue As String = String.Empty ''' <summary> ''' 顯示文字。 ''' </summary> < _ Description("顯示文字。") _ > _ Public Property Text() As String Get Return FText End Get Set(ByVal value As String) FText = value End Set End Property ''' <summary> ''' 關聯值。 ''' </summary> < _ Description("關聯值。") _ > _ Public Property Value() As String Get Return FValue End Get Set(ByVal value As String) FValue = value End Set End Property End Class

再是繼承 CollectionBase 來撰寫 TListItemCollection 集合類別，覆寫 Item 屬性傳回 TListItem 型別，再加入 Add、Insert、Remove 等集合的操作方法。同樣地，也是用 <System.Serializable()> 將 TListItemCollection 集合類別標記為可序列化。

Imports System Imports System.Collections Imports System.Collections.Specialized Imports System.ComponentModel ''' <summary> ''' TListItem 成員集合。 ''' </summary> <System.Serializable()> _ Public Class TListItemCollection Inherits CollectionBase ''' <summary> ''' 依指定索引取得成員。 ''' </summary> Default Public Overloads Property Item(ByVal Index As Integer) As TListItem Get Return CType(Me.List(Index), TListItem) End Get Set(ByVal Value As TListItem) Me.List(Index) = Value End Set End Property ''' <summary> ''' 加入成員。 ''' </summary> ''' <param name="value">成員。</param> Public Function Add(ByVal value As TListItem) As Integer Return Me.List.Add(value) End Function ''' <summary> ''' 取得成員索引。 ''' </summary> ''' <param name="value">成員。</param> Public Function IndexOf(ByVal value As TListItem) As Integer Return Me.List.IndexOf(value) End Function ''' <summary> ''' 插入成員。 ''' </summary> ''' <param name="index">索引。</param> ''' <param name="value">成員。</param> Public Sub Insert(ByVal index As Integer, ByVal value As TListItem) List.Insert(index, value) End Sub ''' <summary> ''' 移除成員。 ''' </summary> ''' <param name="value">成員。</param> Public Sub Remove(ByVal value As TListItem) List.Remove(value) End Sub ''' <summary> ''' 判斷集合是否包含指定成員。 ''' </summary> ''' <param name="value">成員。</param> Public Function Contains(ByVal value As TListItem) As Boolean Return List.Contains(value) End Function End Class

接下來我們要將 TListItemCollection 集合類別使用到控制項的集合屬性，撰寫一個測試的伺服器控制項，加入 TListItemCollection 型別的 Items 屬性。

Imports System Imports System.Collections.Generic Imports System.ComponentModel Imports System.Text Imports System.Web Imports System.Web.UI Imports System.Web.UI.WebControls < _ Description("集合屬性測試控制項"), _ ToolboxData("<{0}:MyControl runat=server></{0}:MyControl>") _ > _ Public Class MyControl Inherits WebControl Private FItems As TListItemCollection < _ Description("TListItem 集合。"), _ System.Web.UI.PersistenceMode(PersistenceMode.InnerProperty), _ DesignerSerializationVisibility(DesignerSerializationVisibility.Content), _ Editor(GetType(System.ComponentModel.Design.CollectionEditor), GetType(System.Drawing.Design.UITypeEditor)) _ > _ Public ReadOnly Property Items() As TListItemCollection Get If FItems Is Nothing Then FItems = New TListItemCollection() End If Return FItems End Get End Property Protected Overrides Sub Render(ByVal writer As System.Web.UI.HtmlTextWriter) writer.Write("控制項集合屬性") MyBase.Render(writer) End Sub End Class

控制項使用設計階段屬性 PersistenceMode 及 DesignerSerializationVisibility 設定屬性序列化後在 aspx 程式碼中的儲存方式。

System.Web.UI.PersistenceMode(PersistenceMode.InnerProperty)
DesignerSerializationVisibility(DesignerSerializationVisibility.Content)

使用 Editor 設計階段屬性，來設定該屬性的設計階段編輯器。

Editor(GetType(System.ComponentModel.Design.CollectionEditor), GetType(System.Drawing.Design.UITypeEditor))

完成這個集合屬性後，就將其拖曳到頁面上在屬性視窗設定 Items 屬性時，就會出現如下的集合編輯器。

再來切換到 aspx 程式碼，去看一下屬性序列化的結果。

<cc1:MyControl ID="MyControl1" runat="server"> <Items> <cc1:TListItem Text="項目一" Value="0"></cc1:TListItem> <cc1:TListItem Text="項目二" Value="1"></cc1:TListItem> <cc1:TListItem Text="項目三" Value="2"></cc1:TListItem> </Items> </cc1:MyControl>

範例程式下載：http://uploadingit.com/files/353947_3ygao/CollectionBase.zip

ASP.NET 魔法學院