1. 實現連字符形式複雜屬性
連字符形式屬性是比較常見的複雜屬性。我們常用的Font屬性就是一個複雜屬性,其包括多個子屬性,如Bold、Name等。這種類型屬性具有兩種語法格式:一種是利用連字符語法,在控件的開始標記中保存子屬性,例如,Font-Bold,Font-Name。另外一種格式是在控件的標記中保存子屬性,例如,<font Bold="true" />。後者比前者的可讀性強。
實現連字符形式的複雜屬性,必須對該複雜屬性及其子屬性實現設置指定的設計時元數據。下面首先列舉了複雜屬性實現過程中的相關元數據設置示例。請閱讀下面的源代碼。
public class CustomerControl:WebControl{ [ DesignerSerializationVisibility( DesignerSerializationVisibility.Content), NotifyParentProperty(true) ] public SizeInfo Size { ...... } } |
如上代碼所示,Size是一個複雜屬性,其屬性類型爲SizeInfo(自定義類)。在Size屬性實現前設置了兩個設計時元數據:DesignerSerializationVisibility和NotifyParentProperty。DesignerSerializationVisibility用於指定在設計時序列化組件上的屬性時,所使用的持久性類型。其值設置爲DesignerSerializationVisibility.Content枚舉值,用於指定序列化程序應該序列化屬性的內容即子屬性,而不是Size屬性本身,因爲序列化Size沒有任何意義。另外,還包括一個NotifyParentProperty(true)設置,它的作用是使得屬性瀏覽器中對子屬性的修改通知一直上傳到對象模型,並在被修改了子屬性的控件中產生修改通知。
在完成了複雜屬性的元數據設置後,開發人員還必須對子屬性設置相關的設計時元數據。例如,Size包括兩個子屬性Height和Width,那麼它們的實現代碼應如下所示。
[TypeConverter(typeof(ExpandableObjectConverter))]public class SizeInfo{ [ NotifyParentProperty(true) ] public UInt32 Height {......} [ NotifyParentProperty(true) ] public UInt32 Width {......} } |
如上代碼所示,子屬性Height和Width分別被設置了元數據NotifyParentProperty(true)。這樣,當子屬性發生修改時,.NET框架將自動產生修改通知,並且通知到父屬性Size。另外,還有一個設計時特性TypeConverter(typeof(ExpandableObjectConverter)),它告訴屬性瀏覽器提供擴展和摺疊樣式,這樣控件開發者可以在屬性瀏覽器中直接編輯子屬性。
以上介紹了聲明連字符形式屬性的方法。從中可以看出,在聲明連字符屬性過程中需要把握兩個要點:一是複雜屬性的設計時元數據設置;二是子屬性的設計時特性設置。
2. 實現內部嵌套形式複雜屬性
通常情況下,開發人員多實現連字符形式的複雜屬性。然而,對複雜屬性還可以實現內部嵌套的形式。下面的代碼就是一個典型的內部潛逃形式複雜屬性的應用。
<MyControl:CustomeControl id="demo1" runat="server"> <HeaderStyle ForeColor="#FFFF00" BackColor="#99ff00"> </HeaderStyle> ... ... </MyControl: CustomeControl> |
如上代碼所示,自定義控件MyControl的屬性HeaderStyle是一個典型的內部嵌套形式屬性。實現這種形式的屬性與實現連字符形式屬性有很大不同,需要分爲兩種情況。
如果自定義服務器控件類繼承自Control類,那麼必須在控件類之前設置元數據屬性ParseChildren和PersistChildren。示意性代碼如下所示。
[ParseChildren(true),PersistChildren(false)]
public class CustomeControl:Control{ ......} |
如上代碼所示,在控件類前設置了兩個元數據屬性ParseChildren和PersistChildren。前者用於告知頁面分析器把控件標記中的內容解析爲屬性還是子控件,該屬性值設置爲true,則表示解析爲屬性。後者用於告知設計器把控件標記中的內容保存爲屬性還是子控件,該屬性值設置爲false,表示保存爲屬性。
如果自定義控件類繼承自WebControl類,那麼就不需要以上的元數據屬性設置,因爲,WebControl類已經應用了這些元數據屬性了。
無論自定義控件類繼承自WebControl類還是Control類,爲實現內部嵌套形式複雜屬性,都必須在屬性實現中設置如下元數據屬性。
[ DesignerSerializationVisibility( DesignerSerializationVisibility.Content), NotifyParentProperty(true), PersistenceMode(PersistenceMode.InnerProperty)]
public TableItemStyle HeaderStyle{......} |
由上面的代碼可以看到,必須在實現複雜屬性之前,應用3個元數據屬性:DesignerSerializationVisibility、NotifyParentProperty和PersistenceMode。前兩個元數據屬性在前文中已經說明,第三個PersistenceMode用於指定如何將服務器控件屬性或事件保持到ASP.NET頁的元數據屬性,該特性的值設置爲枚舉值:PersistenceMode.InnerProperty,這表示將所標識屬性(HeaderStyle)保持爲嵌套標記。
以上介紹了內部嵌套形式屬性聲明的方法。總結起來分爲兩種情況:一是所開發控件從Control派生,則需要設置五個設計時特性ParseChildrenAttribute(true)、PersistChildren(false)、DesignerSerializationVisibility、NotifyParentProperty和PersistenceMode。前兩個特性在控件類前設置,用於告訴編譯器將控件標記內的內容爲屬性,需要解析爲屬性;後三個特性在屬性前指定,用於指示編譯器此屬性爲內部嵌套形式屬性,在應用控件屬性時,必須採用嵌套形式。二是所開發控件從WebControl派生,這種情況比較簡單,只需設置上文中後3個設計時特性即可。
3. 實現內部嵌套形式默認複雜屬性
內部嵌套形式默認屬性與內部嵌套形式屬性非常類似,它通常用於設置某個控件的集合屬性。例如,標準服務器控件中的DataList、DropDownList控件中的屬性均爲內部嵌套形式默認屬性。
爲了實現這種形式的屬性,主要需設置兩個元數據屬性:一是在控件類前設置ParseChildren(true, "DefaultPropertyName"),指定該控件中嵌套的標記表示屬性,而非子控件,同時將嵌套屬性分析爲該控件的集合屬性;二是在集合屬性前設置特性PersistenceMode(PersistenceMode.InnerDefaultProperty),表示將該屬性定義爲控件的默認屬性。
4. 小結
本文介紹了創建複雜屬性的實現方法。這是實現自定義服務器控件過程中的重點和難點內容。在隨後的一篇文章中,我們將通過示例來加深對複雜屬性實現方法的認識。