為asp.net中的Web使用者控制項添加屬性和事件

為asp.net中的Web使用者控制項添加屬性和事件

作者：鄭佐 2004-04-02         
        在90年代初，Microsoft為Web程式員提供的 Active Server Pages(ASP)革命性地改變了Web的編程。它可以利用十分易用的模型在Web伺服器上動態產生HTML，並且很容易的實現了對資料庫的訪問，就當時來說，這是一項多麼迷人的技術，包括現在Internet上的許多web網站都是用Asp寫的，我的同事前輩們更是玩Asp的高手，經曆這麼多年而不衰，可見他的成功。
         但是，技術是在不斷的發展著，引用某位Net專家的話講――如今Web編程的狀態還是落後的。因此Microsoft提出了第二代編程模型――Web表單。Web表單模型作為Asp.net的一部分，而Asp.net又是.Net架構的一個部分。他的編程模型是基於事件的，使用他更像是在進行Windows表單編程，這一點也正是我決定去學習使用他的一個重要原因，也胡亂看了一些這方面的書，寫這篇文章的目的也就是和各位Asp.net初學者和還沒有為使用者控制項添加過自訂事件的同行分享一下經驗。
 廢話少說，下面就讓我們先建立一個使用者控制項吧，這裡就用一個簡單登入使用者控制項來做示範。
 先來看看使用者控制項的前台代碼(LogInOutControl.ascx檔案)：

<%@ Control Language="c#" AutoEventWireup="false" Codebehind="LogInOutControl.ascx.cs" Inherits="ZZ.LogInOutControl" TargetSchema="http://schemas.microsoft.com/intellisense/ie5"%> <TABLE id="Table1" style="FONT-SIZE: 9pt; WIDTH: 183px; HEIGHT: 125px" cellSpacing="1"  cellPadding="1" width="183" align="center" border="1">  <TR>   <TD height="20">    <asp:Label id="LabelUser" runat="server">使用者：</asp:Label>    <asp:TextBox id="TextBoxUserName" Width="128px" runat="server"></asp:TextBox></TD>  </TR>  <TR>   <TD height="20"><FONT face="宋體">     <asp:Label id="LabelPassword" runat="server">密碼：</asp:Label>     <asp:TextBox id="TextBoxPassword" Width="128px" runat="server" TextMode="Password"></asp:TextBox></FONT></TD>  </TR>  <TR>   <TD align="center" height="20"><FONT face="宋體">     <asp:Button id="ButtonLogIn" Width="50px" Text="登入" runat="server"></asp:Button>     <asp:Button id="ButtonLogOut" Width="49px" Text="登出" runat="server"></asp:Button></FONT></TD>  </TR> </TABLE>

我們簡單的放了兩個Label，兩個TextBox，兩個Button以及一個Html表。
接下去就是為LogInOutControl.ascx.cs檔案添加代碼了。
首先定義一個delegate，其中LogInOutEventArgs類是從EventArgs類繼承，

public delegate void LogInOutClickHandler(object sender,LogInOutEventArgs e);

我覺得把這個delegate放在LogInOutControl類外面更為合適。
接下去為控制項聲明了LogInOutClick事件，如下：

public event LogInOutClickHandler LogInOutClick;

另外為了更好的使用屬性，加了Language枚舉，

private Language language;

當然外部通過public Language Lg {get;set;}屬性來訪問。目的就是改變或者擷取當前控制項的顯示。
接下去就是定義控制項事件觸發函數OnLogInOutClick，由按鈕單擊事件處理函數來完成對使用者控制項事件的觸發。
完整代碼如下：

namespace ZZ {  using System;  using System.Data;  using System.Drawing;  using System.Web;  using System.Web.UI.WebControls;  using System.Web.UI.HtmlControls;  // 定義代理  public delegate void LogInOutClickHandler(object sender,LogInOutEventArgs e);  public class LogInOutControl : System.Web.UI.UserControl  {   protected System.Web.UI.WebControls.Button ButtonLogIn;   protected System.Web.UI.WebControls.TextBox TextBoxUserName;   protected System.Web.UI.WebControls.TextBox TextBoxPassword;   protected System.Web.UI.WebControls.Button ButtonLogOut;   protected System.Web.UI.WebControls.Label LabelUser;   protected System.Web.UI.WebControls.Label LabelPassword;   public event LogInOutClickHandler LogInOutClick;   private Language language;   //方法   public void ChangeLanguage(Language language)   {    this.Lg = language;   }   //屬性   public Language Lg   {    set    {     if(value!=this.language)     {      if(value==Language.English)      {       this.LabelUser.Text = "User:";       this.LabelPassword.Text ="Password:";       this.ButtonLogIn.Text = "LogIn";       this.ButtonLogOut.Text = "LogOut";      }      else      {       this.LabelUser.Text = "使用者：";       this.LabelPassword.Text ="密碼：";       this.ButtonLogIn.Text = "登入";       this.ButtonLogOut.Text = "登出";      }     }    }   }   private void Page_Load(object sender, System.EventArgs e)   {    if(this.LabelUser.Text=="User:")      this.language = Language.English;     else      this.language = Language.Chinese;   }   private void OnLogInOutClick(object sender,LogInOutEventArgs e)   {    if(LogInOutClick!=null)     LogInOutClick(this,e);   }   #region Web Form設計器產生的程式碼   override protected void OnInit(EventArgs e)   {    InitializeComponent();    base.OnInit(e);   } private void InitializeComponent()   {    this.ButtonLogIn.Click += new System.EventHandler(this.ButtonLogIn_Click);    this.ButtonLogOut.Click += new System.EventHandler(this.ButtonLogOut_Click);    this.Load += new System.EventHandler(this.Page_Load);   }   #endregion   private void ButtonLogIn_Click(object sender, System.EventArgs e)   {    OnLogInOutClick(this,new LogInOutEventArgs(LogInClickType.LongIn,CustomValidate(this.TextBoxUserName.Text,this.TextBoxPassword.Text)));   }   private void ButtonLogOut_Click(object sender, System.EventArgs e)   {    //登出代碼省略    OnLogInOutClick(this,new LogInOutEventArgs(LogInClickType.LongOut,true));   }   //驗證函式   private bool CustomValidate(string userName,string password)   {    //驗證代碼省略，假設通過    return true;   }  } }

另外一個檔案定義了枚舉和參數類：

using System; namespace ZZ {  public class LogInOutEventArgs : EventArgs  {   private LogInClickType type;   private bool result;      public LogInOutEventArgs(LogInClickType type,bool result):base()   {    this.type = type;    this.result = result;   }   public LogInClickType Type   {    get{return this.type;}   }   //操作結果，   public bool Result   {    get{return this.result;}   }  }  //操作類型  public enum LogInClickType : int  {   LongIn,   LongOut  }  //定義語言  public enum Language  {   Chinese,   English  } }

接下去看看在aspx頁面裡面使用。
建立一個Default.aspx頁面，拖一個LogInOutControl使用者控制項到上面。

<%@ Register TagPrefix="uc1" TagName="LogInOutControl" Src="LogInOutControl.ascx" %> <%@ Page language="c#" Codebehind="Default.aspx.cs" AutoEventWireup="false" Inherits="ZZ.Default" %> <%@ Import Namespace="ZZ" %> <HTML>  <HEAD>   <title>WebForm1</title>  </HEAD>  <body>   <form id="Form1" method="post" runat="server">    <FONT face="宋體">     <uc1:LogInOutControl id="LogInOutControl1" runat="server">     </uc1:LogInOutControl>     <asp:Label id="LabelMsg" runat="server"></asp:Label>     <asp:DropDownList id="DropDownList1" runat="server" AutoPostBack="True">      <asp:ListItem Value="0" Selected="True">中文</asp:ListItem>      <asp:ListItem Value="1">英文</asp:ListItem>     </asp:DropDownList></FONT>   </form>  </body> </HTML>

在後台代碼中添加事件和屬性。
雖然在前台添加了LogInOutControl1，但是後台代碼中不會產生protected LogInOutControl LogInOutControl1;這條語句，我覺得很奇怪，不管先加上他。
接著在Page_Load事件中註冊LogInOutClick事件：

this.LogInOutControl1.LogInOutClick += new LogInOutClickHandler(LogInOutControl1_LogInOutClick);

完整代碼如下：

using System; using System.Collections; using System.ComponentModel; using System.Data; using System.Drawing; using System.Web; using System.Web.SessionState; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.HtmlControls; namespace ZZ {  public class Default : System.Web.UI.Page  {   protected System.Web.UI.WebControls.Label LabelMsg;   protected System.Web.UI.WebControls.DropDownList DropDownList1;   protected LogInOutControl LogInOutControl1;   private void Page_Load(object sender, System.EventArgs e)   {    //註冊使用者控制項事件    this.LogInOutControl1.LogInOutClick += new LogInOutClickHandler(LogInOutControl1_LogInOutClick);   }   #region Web Form設計器產生的程式碼   override protected void OnInit(EventArgs e)   {    InitializeComponent();    base.OnInit(e);   }   private void InitializeComponent()   {       this.DropDownList1.SelectedIndexChanged += new System.EventHandler(this.DropDownList1_SelectedIndexChanged);    this.Load += new System.EventHandler(this.Page_Load);   }   #endregion   private void LogInOutControl1_LogInOutClick(object sender, LogInOutEventArgs e)   {    switch(e.Type)    {     case LogInClickType.LongIn:      this.LabelMsg.Text = "你點擊了登入按鈕，操作結果："+e.Result.ToString();      break;     case LogInClickType.LongOut:      this.LabelMsg.Text = "你點擊了登出按鈕，操作結果："+e.Result.ToString();      break;    }   } private void DropDownList1_SelectedIndexChanged(object sender, System.EventArgs e)   {    this.LogInOutControl1.Lg = (Language)this.DropDownList1.SelectedIndex;    //this.LogInOutControl1.ChangeLanguage((Language)this.DropDownList1.SelectedIndex);   }  } }

當使用者在前台通過選擇下拉框列表來改變控制項的語言，這裡通過Lg屬性來完成，不過這裡也加了一個方法ChangeLanguage也可以實現同樣的功能。另外，通過點擊登陸或登出按鈕觸發LogInOutClick事件來給頁面中的LabelMsg.Text屬性賦值從而得到操作結果。
       總結，使用者控制項為程式員帶來了很高的開發效率和重用性，更是在效能方面有了很大的提高，以前稱為Asp+，其實我認為Asp.net跟Asp沒有什麼直接聯絡。而且我想做應用程式的朋友和我一樣在開發Web程式時更喜歡採用代碼分離方式，這樣結構更清晰，便與修改和管理。同Asp程式相比，他是編譯型的，引入了物件導向的設計思想，也就不可避免的帶來了他的複雜性，要想開發高水準的Asp.net程式，對於模式的設計，階層的劃分，這裡還是比較講究的。總之，他更像是在編Windows表單程式，而不是在寫VB指令碼。