ASP.NET服務(wù)器控件開發(fā)（1）封裝html

更新時(shí)間：2015年12月29日 21:37:53 投稿：mdxy-dxy

在我們的項(xiàng)目開發(fā)中，由于ASP.NET的服務(wù)器控件功能有限，所以我們經(jīng)常會(huì)自己定義特定的服務(wù)器控件，來滿足開發(fā)中特定的業(yè)務(wù)要求。可見知道如何開發(fā)ASP.NET服務(wù)器控件是非常有必要的

在我們的項(xiàng)目開發(fā)中，由于ASP.NET的服務(wù)器控件功能有限，所以我們經(jīng)常會(huì)自己定義特定的服務(wù)器控件，來滿足開發(fā)中特定的業(yè)務(wù)要求?？梢娭廊绾伍_發(fā)ASP.NET服務(wù)器控件是非常有必要的。

其實(shí)簡單的實(shí)現(xiàn)ASP.NET服務(wù)器控件不是很難，以前園子中也有大牛介紹過相應(yīng)的內(nèi)容，這里站在巨人的肩膀上也來分享下開發(fā)ASP.NET服務(wù)器控件的方法和自己的一些體會(huì)。寫給新手，高手繞過。

學(xué)習(xí)ASP.NET的服務(wù)器控件開發(fā)，個(gè)人認(rèn)為最好的方式就是自己去實(shí)踐，當(dāng)然理論知識(shí)也是很重要的，但是如果我們只是看理論的知識(shí)，可能會(huì)被里面的一些概念鬧糊涂，看著看著就睡著了，如果自己動(dòng)手創(chuàng)做出一個(gè)自己的控件，效果就不一樣了。

下面就通過實(shí)例創(chuàng)建一個(gè)簡單的服務(wù)器控件：

首先我們創(chuàng)建一個(gè)類庫工程SelfWebControl。在同一解決方案中我們在創(chuàng)建一個(gè)ASP,NET Web應(yīng)用程序（用來測試我們得控件）

namespace SelfWebControl
{
  public class ControlA:Control//Control類中定義了所有ASP.NET服務(wù)器控件共享的屬性和方法
  {

  }
}

我將ControlA類繼承Control類，Control類是.NET中所有控件的基類，其中包含了控件共有的屬性和方法。

Control類

公共屬性：

ClientID 獲取由 ASP.NET 生成的服務(wù)器控件標(biāo)識(shí)符。

Controls 獲取 ControlCollection 對象，該對象表示 UI 層次結(jié)構(gòu)中指定服務(wù)器控件的子控件。

EnableViewState 獲取或設(shè)置一個(gè)值，該值指示服務(wù)器控件是否向發(fā)出請求的客戶端保持自己的視圖狀態(tài)以及它所包含的任何子控件的視圖狀態(tài)。

ID 獲取或設(shè)置分配給服務(wù)器控件的編程標(biāo)識(shí)符。

NamingContainer 獲取對服務(wù)器控件的命名容器的引用，此引用創(chuàng)建唯一的命名空間，以區(qū)分具有相同 Control.ID 屬性值的服務(wù)器控件。

Page 獲取對包含服務(wù)器控件的 Page 實(shí)例的引用。

Parent 獲取對頁 UI 層次結(jié)構(gòu)中服務(wù)器控件的父控件的引用。

Site 獲取有關(guān)服務(wù)器控件所屬 Web 站點(diǎn)的信息（原文自MSDN,但是我認(rèn)為不對，應(yīng)該是指組件的“容器”站點(diǎn)，并非 web site）。

TemplateSourceDirectory 獲取包含當(dāng)前服務(wù)器控件的 Page 或 UserControl 的虛擬目錄。

UniqueID 獲取服務(wù)器控件的唯一的、以分層形式限定的標(biāo)識(shí)符。

Visible 獲取或設(shè)置一個(gè)值，該值指示服務(wù)器控件是否作為 UI 呈現(xiàn)在頁上。

公共方法：

DataBind 將數(shù)據(jù)源綁定到被調(diào)用的服務(wù)器控件及其所有子控件。

Dispose 使服務(wù)器控件得以在從內(nèi)存中釋放之前執(zhí)行最后的清理操作。

Equals（從 Object 繼承）已重載。確定兩個(gè) Object 實(shí)例是否相等。

FindControl 已重載。在當(dāng)前的命名容器中搜索指定的服務(wù)器控件。

GetHashCode（從 Object 繼承）用作特定類型的哈希函數(shù)，適合在哈希算法和數(shù)據(jù)結(jié)構(gòu)（如哈希表）中使用。

GetType（從 Object 繼承）獲取當(dāng)前實(shí)例的 Type。

HasControls 確定服務(wù)器控件是否包含任何子控件。

RenderControl 將服務(wù)器控件的內(nèi)容輸出到所提供的 HtmlTextWriter 對象中；如果已啟用跟蹤功能，則存儲(chǔ)有關(guān)控件的跟蹤信息。

ResolveUrl 根據(jù)傳遞給 TemplateSourceDirectory 屬性的值，將相對 URL 解析為絕對 URL。

ToString（從 Object 繼承）返回表示當(dāng)前 Object 的 String。

公共事件：

DataBinding 當(dāng)服務(wù)器控件綁定到數(shù)據(jù)源時(shí)發(fā)生。

Disposed 當(dāng)從內(nèi)存釋放服務(wù)器控件時(shí)發(fā)生，這是請求 ASP.NET 頁時(shí)服務(wù)器控件生存期的最后階段。

Init 當(dāng)服務(wù)器控件初始化時(shí)發(fā)生；初始化是控件生存期的第一步。服務(wù)器控件應(yīng)執(zhí)行任何創(chuàng)建和設(shè)置實(shí)例所需的初始化步驟。在該事件內(nèi)無法使用視圖狀態(tài)信息；它尚未填充。在該事件的生存期內(nèi)不應(yīng)訪問其他服務(wù)器控件，不論它是此控件的子級還是父級。不一定會(huì)創(chuàng)建其他服務(wù)器控件，也不一定能夠訪問它們。

Load 當(dāng)服務(wù)器控件加載到 Page 對象中時(shí)發(fā)生。通知服務(wù)器控件執(zhí)行任何設(shè)置為在每次頁請求時(shí)發(fā)生的處理步驟。開發(fā)者可以訪問視圖狀態(tài)信息并利用該事件形成 POST 數(shù)據(jù)。還可以訪問頁控件層次結(jié)構(gòu)內(nèi)的其他服務(wù)器控件。

PreRender 當(dāng)服務(wù)器控件將要呈現(xiàn)給其包含的 Page 對象時(shí)發(fā)生。使用該事件在服務(wù)器控件呈現(xiàn)給頁的輸出之前執(zhí)行任何更新。在該事件的生存期內(nèi)可以保存服務(wù)器控件視圖狀態(tài)的任何更改。不保存呈現(xiàn)階段內(nèi)所做的同樣更改。

Unload 當(dāng)服務(wù)器控件從內(nèi)存中卸載時(shí)發(fā)生。

保護(hù)的屬性：

ChildControlsCreated 獲取一個(gè)值，該值指示是否已創(chuàng)建服務(wù)器控件的子控件。

Context 為當(dāng)前 Web 請求獲取與服務(wù)器控件關(guān)聯(lián)的 HttpContext 對象。

Events 獲取控件的事件處理程序委托列表。此屬性為只讀。

HasChildViewState 獲取一個(gè)值，該值指示當(dāng)前服務(wù)器控件的子控件是否具有任何已保存的視圖狀態(tài)設(shè)置。

IsTrackingViewState 獲取一個(gè)值，該值指示服務(wù)器控件是否將更改保存到其視圖狀態(tài)。

ViewState 獲取狀態(tài)信息的字典，這些信息使您可以在同一頁的多個(gè)請求間保存和還原服務(wù)器控件的視圖狀態(tài)。

ViewStateIgnoresCase 獲取一個(gè)值，該值指示 StateBag 對象是否不區(qū)分大小寫。

受保護(hù)的方法：

AddParsedSubObject 通知服務(wù)器控件某個(gè)元素（XML 或 HTML）已經(jīng)過語法分析，并將該元素添加到服務(wù)器控件的 ControlCollection 對象。

ClearChildViewState 刪除服務(wù)器控件的所有子控件的視圖狀態(tài)信息。

CreateChildControls 通知使用基于合成的實(shí)現(xiàn)的服務(wù)器控件創(chuàng)建它們包含的任何子控件，以便為回發(fā)或呈現(xiàn)做準(zhǔn)備。

CreateControlCollection 創(chuàng)建一個(gè)新的 ControlCollection 對象來保存服務(wù)器控件的子控件（包括文本控件和服務(wù)器控件）。

EnsureChildControls 確定服務(wù)器控件是否包含子控件。如果不包含，則創(chuàng)建子控件。

Finalize（從 Object 繼承）已重寫。允許 Object 在“垃圾回收”回收 Object 之前嘗試釋放資源并執(zhí)行其他清理操作。

IsLiteralContent 確定服務(wù)器控件是否只包含文字內(nèi)容。Asp.net頁面中普通的html標(biāo)簽被asp.net編譯為一個(gè) LiteralContent控件（意味著輕型控件）。

LoadViewState 從 SaveViewState 方法保存的上一個(gè)頁請求還原視圖狀態(tài)信息。

MapPathSecure 如果請求服務(wù)器控件有足夠的安全權(quán)限讀取映射結(jié)果，檢索相對于源文件的映射物理文件路徑。

MemberwiseClone（從 Object 繼承）創(chuàng)建當(dāng)前 Object 的淺表副本。

OnBubbleEvent 確定服務(wù)器控件的事件是否沿頁的 UI 服務(wù)器控件層次結(jié)構(gòu)向上傳遞。

OnDataBinding 引發(fā) DataBinding 事件。

OnInit 引發(fā) Init 事件。

OnLoad 引發(fā) Load 事件。

OnPreRender 引發(fā) PreRender 事件。

OnUnload 引發(fā) Unload 事件。注意在服務(wù)器控件生存期的此階段，服務(wù)器控件應(yīng)執(zhí)行所有最后的清理操作，例如關(guān)閉文件、關(guān)閉數(shù)據(jù)庫連接和丟棄對象。

RaiseBubbleEvent 將所有事件源及其信息分配給控件的父級。

Render 將服務(wù)器控件內(nèi)容發(fā)送到提供的 HtmlTextWriter 對象，此對象編寫將在客戶端呈現(xiàn)的內(nèi)容。

RenderChildren 將服務(wù)器控件子級的內(nèi)容輸出到提供的 HtmlTextWriter 對象，此對象編寫將在客戶端呈現(xiàn)的內(nèi)容。

SaveViewState 保存自頁回發(fā)到服務(wù)器后發(fā)生的任何服務(wù)器控件視圖狀態(tài)更改。

TrackViewState 導(dǎo)致跟蹤服務(wù)器控件的視圖狀態(tài)的更改，以便這些更改可以存儲(chǔ)到服務(wù)器控件的 StateBag 對象中。通過 Control.ViewState 屬性可訪問此對象。

這里我們要重寫Render方法，通過HtmlTextWriter 對象將控件中的內(nèi)容顯示出去。

namespace SelfWebControl
{
  public class ControlA:Control//Control類中定義了所有ASP.NET服務(wù)器控件共享的屬性和方法
  {
    protected override void Render(HtmlTextWriter writer)
    {
      writer.Write("<table style='width:300px; height:200px; background-color:Bisque'>");
      writer.Write("<tr>");
      writer.Write("<td>這是第一列</td>");
      writer.Write("<td>這是第二列</td>");
      writer.Write("<td>這是第三列</td>");
      writer.Write("</tr>");
      writer.Write("</table>");
    }
  }
}

生成我們得SelfWebControl工程，再切換到ASP.NET應(yīng)用程序的工具箱時(shí)，VS2008會(huì)自動(dòng)的將我們剛剛創(chuàng)建的ControlA添加到工具箱中，避免了我們以前通過選擇項(xiàng)添加控件的過程。

這樣，我們就已最簡單的形式實(shí)現(xiàn)了一個(gè)ASP.NET服務(wù)器控件。但是如果我想修改表格的寬度，高度，背景色該怎么改呢？

這就需要我們定義服務(wù)器控件的屬性。大家也都知道，ASP.NET的服務(wù)器控件有很多屬性，而我們現(xiàn)在的控件只有公有的幾個(gè)屬性。

先來看看我們做了那些改動(dòng)：

public class ControlA:Control//Control類中定義了所有ASP.NET服務(wù)器控件共享的屬性和方法
  {
    private int _tWidth;
    private int _tHeight;
    private string _bgColor;

    
    [Browsable(true)]//在屬性窗口中是否可見
    [Category("Appearance")]//屬性的分類，如，行為，外觀，大家可以在屬性窗口看見這樣的分類
    [DefaultValue(100)]//屬性的默認(rèn)值
    [Description("表格寬度")]//這些是顯示在屬性窗口底下的
    public int tWidth
    {
      get { return _tWidth; }
      set { _tWidth = value; }
    }

    [Browsable(true)]
    [Category("Appearance")]
    [DefaultValue(100)]
    [Description("表格高度")]
    public int tHeight
    {
      get { return _tHeight; }
      set { _tHeight = value; }
    }

    [Browsable(true)]
    [Category("Appearance")]
    [DefaultValue("Bisque")]
    [Description("表格背景顏色")]
    public string bgColor
    {
      get { return _bgColor; }
      set { _bgColor = value; }
    }

    protected override void Render(HtmlTextWriter writer)
    {
      writer.Write("<table style='width:" + tWidth + "px; height:"+tHeight+"px; background-color:"+bgColor+"'>");
      writer.Write("<tr>");
      writer.Write("<td>這是第一列</td>");
      writer.Write("<td>這是第二列</td>");
      writer.Write("<td>這是第三列</td>");
      writer.Write("</tr>");
      writer.Write("</table>");
    }
  }

代碼很簡單，想必大家都能看懂，值得注意的就是對每一個(gè)屬性的聲明。需要引用命名空間：using System.ComponentModel;每一個(gè)標(biāo)簽的作用我已經(jīng)在代碼中做了說明，這樣我們就為我們得控件添加了屬性.

還要說明一點(diǎn)的就是，如果我們想在把控件拖到頁面中時(shí)標(biāo)簽內(nèi)自動(dòng)的添加一些屬性，需要添加下面的代碼：

復(fù)制代碼代碼如下:

[ToolboxData("<{0}:ControlA runat='server' bgColor='red' tHeight='200' tWidth='300'></{0}:ControlA>")]

值得注意的是這里的寫法，{0}的冒號(hào)中之后的那個(gè)"ControlA“就是類的名字，不要寫錯(cuò)。還有runat='sever'一定要寫。

是不是很簡單，這樣，我們只是封裝了簡單的html來完成ASP.NET控件的制作。

小結(jié)：簡單的制作一個(gè)ASP.NET的服務(wù)器控件很簡單，但是光只是通過html的輸出有的時(shí)候意義不大，這里只是介紹一種方法和思路。打開學(xué)習(xí)定制自己的ASP.NET控件的第一扇門。在以后的文章中我會(huì)介紹針對于繼承WebControl開發(fā)ASP.NET控件。