ASP.NET服務器控件之RenderContents應用示例
ASP.NET服務器控件之RenderContents應用示例
相信讀者在瀏覽各個網站時，經常會看到"聯系我們"等類似文字。當單擊這些文字時，操作系統將自動打開自身所帶的郵件客戶端軟件，提示用戶發送郵件。本例將實現一個自定義服務器控件RenderContentsControl，其用于通過呈現包含"mailto:郵件地址"的超鏈接。本例的示例效果圖如圖1所示：
如圖1所示，頁面中呈現了超鏈接文字"我的郵箱地址"。當單擊該鏈接，系統將發送郵件給"my@mysample.com"。
在實現以上ASP.NET服務器控件之前，首先應分析如下：本控件包含外觀元素，例如，文字大小、顏色、是否粗體等。為此，控件基類不應從Control類繼承，而應從WebControl類繼承。這樣，開發人員將不必自行實現這些外觀樣式屬性等內容。
下面列舉了實現自定義服務器控件的RenderContentsControl.cs文件源代碼。
- using System;
- using System.ComponentModel;
- using System.Security;
- using System.Security.Permissions;
- using System.Web;using System.Web.UI;
- using System.Web.UI.WebControls;
- namespace UsingRenderContentsControl{
- [
- AspNetHostingPermission(SecurityAction.Demand,
- Level = AspNetHostingPermissionLevel.Minimal),
- AspNetHostingPermission(SecurityAction.InheritanceDemand,
- Level = AspNetHostingPermissionLevel.Minimal),
- DefaultProperty("Email"), ParseChildren(true, "Text"),
- ToolboxData("﹤{0}:RenderContentsControl runat=server﹥﹤/{0}:RenderContentsControl﹥")
- ]
- public class RenderContentsControl : WebControl {
- // 實現Email屬性
- [Bindable(true)]
- [Category("Appearance")]
- [DefaultValue("")] [Localizable(true)]
- public string Email
- {
- get {
- String s = (String)ViewState["Email"];
- return ((s == null) ? String.Empty : s);
- }
- set {
- ViewState["Email"] = value;
- }
- }
- // 實現Text屬性
- [
- Bindable(true), Category("Appearance"), DefaultValue(""), Localizable(true),
- PersistenceMode(PersistenceMode.InnerDefaultProperty)
- ]
- public virtual string Text
- {
- get {
- string s = (string)ViewState["Text"];
- return (s == null) ? String.Empty : s;
- }
- set {
- ViewState["Text"] = value;
- }
- }
- // 重寫TagKey屬性
- protected override HtmlTextWriterTag TagKey
- {
- get {
- return HtmlTextWriterTag.A;
- }
- }
- // 重寫AddAttributesToRender方法
- protected override void AddAttributesToRender(HtmlTextWriter writer)
- {
- base.AddAttributesToRender(writer);
- writer.AddAttribute(HtmlTextWriterAttribute.Href, "mailto:" + Email);
- }
- // 重寫RenderContents方法
- protected override void RenderContents(HtmlTextWriter writer)
- {
- if (Text == String.Empty) {
- Text = Email;
- }
- writer.WriteEncodedText(Text);
- }
- }
- }
如上代碼所示，RenderContentsControl類繼承自WebControl基類，其原因在前文已經說明。另外，在RenderContentsControl類的實現過程中，還包括了元數據屬性標記、3個屬性（Email、Text和TagKey）和2兩個方法（AddAttributesToRender和RenderContents）實現等內容。下面逐一對這些內容進行分析。
代碼說明之3個屬性：
在上文代碼中主要包括了3個屬性：Email、Text和TagKey。Email屬性用于獲取或者設置具體的電子郵件地址，Text屬性用于獲取或者設置控件顯示的文本內容。在這兩個屬性實現中，都使用了控件視圖狀態ViewState。ASP.NET服務器控件的視圖狀態為其所有屬性值的累計。對于簡單屬性的實現，將經常使用ViewState。TagKey屬性是重寫屬性，其繼承自WebControl基類，這是讀者需要理解的重點內容。重寫TagKey屬性主要是為了呈現HTML標記中的a元素，這樣就不會呈現WebControl類所默認呈現的span元素。此處，也暗示了本控件使用的構造函數是繼承自WebControl的protected WebControl ()，讀者可返回上文再看看有關這個構造函數的說明。需要讀者牢記的是：如果要呈現的元素是HtmlTextWriterTag枚舉的成員，則應重寫TagKey屬性。許多常見的HTML元素標記被映射為HtmlTextWriterTag枚舉的值。例如，System.Web.UI.HtmlTextWriterTag.A與a元素對應，而System.Web.UI.HtmlTextWriterTag.Table與table元素對應。如果要呈現的元素不是由HtmlTextWriterTag枚舉的成員表示，那么建議重寫TagName屬性，并返回要作為元素呈現的字符串。
代碼說明之2個方法：
在RenderContentsControl服務器控件中重寫了2個重要方法：一個是AddAttributesToRender、另一個是RenderContents。
（1）AddAttributesToRender
該方法用于為ASP.NET服務器控件添加一個Href屬性，并將該屬性值設置為"mailto:Email"，其中Email是上文所述的表示郵件地址的屬性。當重寫AddAttributesToRender方法時，應始終按照控件源代碼演示的方式：首先，調用基類方法，然后進行相關設置。這樣才能實現為服務器控件添加樣式和其他屬性的功能。實際上，根據前文所述的RenderBeginTag方法的實現示意性代碼可知，AddAttributesToRender方法是由WebControl的RenderBeginTag方法調用。
（2）RenderContents
該方法是本示例的核心內容，其用于在ASP.NET服務器控件的標記中寫入由Text屬性指定的超鏈接文本。如代碼所示，服務器控件調用了HtmlTextWriter實例的WriteEncodedText方法，以對開發人員輸入的文本進行HTML編碼。一般情況下，為了安全起見，應該對用戶提供的文本進行HTML編碼。
代碼說明之元數據屬性標記：
元數據屬性標記在類前和屬性實現前都有所應用。有關這些元數據屬性標記的說明，在以前的文章中已經進行了具體說明。讀者可查閱有關講解如何創建一個簡單的服務器控件的文章。下面重點說明一下有關內部文本持久性的問題。
在類前的元數據屬性標記中，設置了ParseChildren(true, "Text")。在Text屬性前的元數據屬性標記中，設置了PersistenceMode(PersistenceMode.InnerDefaultProperty)。通過以上兩個設置，則為控件添加了內部文本持久性設置。如此設置，可使得開發人員能夠在控件標記代碼內設置Text屬性。例如：
﹤Sample:RenderContentsControl runat="server" ID="CustomerControl" Email="my@mysample.com"﹥我的郵箱地址﹤/Sample:RenderContentsControl﹥
在上面的代碼中，原來文本"我的郵箱地址"應由Text屬性設置（這就是默認持久性），然而，由于內部文本持久性設置，因此，可以在控件標記內設置控件文本。
實現內部持久性，應使用ParseChildren(true, "Text")來標記RenderContentsControl控件。ParseChildren的***個參數true，其用于指定頁分析器應將控件標記內的內容分析為屬性，而不是子控件。第二個參數提供控件的內部默認屬性名稱為Text。使用這兩個參數調用ParseChildren構造函數時，控件標記內的內容必須與內部默認屬性對應。Text屬性的PersistenceMode(PersistenceMode.InnerDefaultProperty)，用于指定可視化設計器應將此屬性作為控件標記中的內部內容進行序列化。
通常，WebControl類使用PersistChildren(false)和ParseChildren(true)控制設計時和分析時屬性的持久性。這兩個屬性將被控件繼承，且僅在要更改繼承的設置時需要應用。PersistChildren告知設計器是否應將ASP.NET服務器控件的子控件作為嵌套的內部控件保存。false參數指示內部內容與屬性對應，而不是與子控件對應。ParseChildren已在上一段中加以說明。如果WebControl類的設計時和分析時持久性適用于您的控件，則不必重寫從WebControl繼承的PersistChildren和ParseChildren。
下面列舉了用于測試服務器控件的Default.aspx文件源代碼：
- ﹤%@ Page Language="C#" AutoEventWireup="true"
- CodeFile="Default.aspx.cs" Inherits="_Default" %﹥
- ﹤%@ Register TagPrefix="Sample"
- Assembly="UsingRenderContentsControl" Namespace="UsingRenderContentsControl" %﹥
- ﹤!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"﹥
- ﹤html xmlns="http://www.w3.org/1999/xhtml"﹥
- ﹤head id="Head1" runat="server"﹥
- ﹤title﹥使用RenderContents方法實現控件呈現﹤/title﹥
- ﹤/head﹥
- ﹤body﹥
- ﹤form id="form1" runat="server"﹥
- ﹤div﹥
- ﹤Sample:RenderContentsControl runat="server"
- ID="CustomerControl" Font-Bold="true" Font-Size="small"
- ForeColor="Blue" Email="my@mysample.com"﹥我的郵箱地址﹤/Sample:RenderContentsControl﹥
- ﹤/div﹥
- ﹤/form﹥
- ﹤/body﹥
- ﹤/html﹥
如上粗體代碼所示，RenderContentsControl控件中設置了Font-Bold、Font-Size、ForeColor、Email等屬性，同時，還在控件標記之間設置了文本內容。當然，如果開發人員將Text屬性值設置為相同的文本內容也是可以的。以上代碼比較簡單，在此不再說明了。
通過這個示例，我們需要重點掌握RenderContents和AddAttributesToRender方法，以及TagKey屬性的使用。提請讀者注意的是雖然服務器控件的代碼比較復雜，但是結構很簡單。切不可被復雜的樣式設置和客戶端行為代碼弄得不知所措，而是要注意體會兩個重點方法的使用過程。
在服務器控件開發成功之后，***能夠查看其HTML代碼，并將服務器代碼和HTML代碼作以比較，搞清楚每一條ASP.NET服務器控件代碼呈現了什么樣的HTML代碼。通過這個方法，相信讀者能夠對ASP.NET服務器控件的呈現方法有更加深刻的體會。下面列舉了當用戶在瀏覽器中運行以上頁面，并查看相關的Html源文件時可得到的代碼：
- ﹤!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"﹥
- ﹤html xmlns="http://www.w3.org/1999/xhtml"﹥
- ﹤head id="Head1"﹥
- ﹤title﹥ 使用RenderContents方法實現控件呈現﹤/title﹥
- ﹤/head﹥
- ﹤body﹥
- ﹤form name="form1" method="post" action="Default.aspx" id="form1"﹥
- ﹤div﹥
- ﹤input type="hidden" name="__VIEWSTATE" id="__VIEWSTATE"
- value="/wEPDwULLTEyNTQwNjQyMDJkZOlJ3PyMGs2hmzn9MU6Ogt9V+5ag" /﹥
- ﹤/div﹥
- ﹤div﹥
- ﹤a id="CustomerControl" href="mailto:my@mysample.com"
- style="color:Blue;font-size:Small;font-weight:bold;"﹥我的郵箱地址﹤/a﹥
- ﹤/div﹥
- ﹤/form﹥
- ﹤/body﹥
- ﹤/html﹥
通過觀察以上代碼可知，自定義服務器控件RenderContentsControl實際呈現的結果是粗體所示部分的代碼，其最終呈現為一個表示超鏈接的﹤a﹥標記，其中包括href、Style和文本等屬性值。它們的值與Default.aspx文件源代碼中，RenderContentsControl控件的屬性設置有著密切關系。例如，Email屬性值最終呈現為href屬性值等等。讀者可自行對照查看，這對于理解控件呈現很有益處。
小結
本文主要介紹了WebControl類的一些基本知識，并且利用這些基本知識創建了一個簡單的控件呈現實例。實際上，從中讀者應該能夠總結出來，創建繼承自WebControl基類的自定義服務器控件，其中最為重要的重寫RenderContents方法。記住這一點是非常重要的。至此，筆者已經利用兩篇文章來介紹實現控件呈現的方法。在以后的文章中，將介紹有關為ASP.NET服務器控件實現屬性等方面的內容。
ASP.NET服務器控件之RenderContents應用示例的相關內容就向你介紹到這里，希望你能了解ASP.NET服務器控件之RenderContents的應用。【編輯推薦】
- ASP.NET服務器控件開發之實現事件淺析
- ASP.NET服務器控件之處理回傳數據淺析
- ASP.NET服務器控件之捕獲回傳事件淺析
- ASP.NET控件開發基礎之事件處理淺析
- ASP.NET服務器控件之RenderContents簡介
