如何編寫ASP.NET的使用者控制元件
本文介紹如何在ASP.NET中建立使用者控制元件,控制元件屬性的動態修改以及控制元件的事件出發機制。
==================================================================
簡介
ASP.NET的服務端控制元件使得Web開發工作變得更為簡單,功能更為強大。我們介紹過如何在ASP.NET頁面中使用服務端控制元件。但是,如果服務端沒有所要求的控制元件時該怎麼辦呢?
當然,ASP.NET不會給你變出一個莫須有的控制元件。事實上,可以動手作自己的控制元件來取代.NET提供的控制元件。這種控制元件就是使用者控制元件,也正是本文討論的話題。
編寫第一個使用者控制元件
有人認為,知道如何使用服務端控制元件可不一定說明編寫使用者控制元件是件容易的事。
事實上,編寫一個基本使用者控制元件(有時也稱之為pagelets)並讓ASP.NET頁面象使用服務端控制元件那樣使用這些控制元件的確是件簡單的事。這裡有一個簡單示例:
basic.ascx
<p>
This is a user control... really!
</p>
這就是一個使用者控制元件!看到這裡,我想你會說我該不是喝醉了,頭腦不清楚吧。但這段程式碼的確就是易於被使用的一個使用者控制元件。儘管這個控制元件沒有作什麼事,卻是關於什麼是使用者控制元件的一個很好說明。事情並不象想像得那麼複雜。注意字尾.ascx,它告訴網頁這是一個使用者控制元件。它沒有什麼特別含義,只是不讓IIS去直接執行這段程式碼。
現在我們來建立一個使用者控制元件,看下面的例子:
basic.aspx
<%@ Page Language="VB" %>
<%@ Register TagPrefix="asp101samps" TagName="SomeText"
Src="basic.ascx" %>
<html>
<head>
<title>ASP.NET User Control Sample - Basic</title>
</head>
<body bgcolor="#FFFFFF">
<asp101samps:SomeText runat="server" />
</body>
</html>
這段程式碼輸出標準HTML頁面,顯示使用者控制元件裡的文字而不是標記。
那麼它是怎麼實現的呢?關鍵就在註冊(Register)說明。要註冊控制元件,先要定義三個屬性:
TagPrefix
定義控制元件位置的名稱空間。有了名稱空間制約,就可以在同一個網頁裡使用不同功能的同名控制元件。
TagName
指向所使用控制元件的名字。在同一個名稱空間裡的控制元件名是唯一的。控制元件名一般都表明控制元件的功能。
Src
指向控制元件的資原始檔。資原始檔使用虛路徑("control.ascx" 或 "/path/control.ascx"),不能使用物理路徑("C:/path/control.ascx.")。
控制元件註冊之後,就可以象其它服務端控制元件一樣被使用。通過定義目標字首(TagPrefix)和目標名(TagName),就可以象使用服務端內建控制元件一樣地進行使用。同時也確定了使用服務端執行(runat="server")方式。下面是網頁呼叫使用者控制元件的基本方式:
<TagPrefix:TagName runat="server" />
給使用者控制元件增加屬性並賦值
下面我給控制元件加上兩個屬性,一個是color,另一個是text。
properties.ascx
<script language="VB" runat="server">
Public Color As String = "black"
Public Text As String = "This is a user control... really!"
</script>
<p>
<font color="<%= Color %>">
<%= Text %>
</font>
</p>
這樣就可以使用和改變控制元件的色彩和文字了。可以在初始化時賦值,還可以動態地修改這二個屬性。
在同一個網頁裡可以重複呼叫這個控制元件並使用不同的屬性值:
properties.aspx
<%@ Page Language="VB" %>
<%@ Register TagPrefix="asp101samps" TagName="SomeText"
Src="properties.ascx" %>
<script language="VB" runat="server">
Sub Page_Load(Sender As Object, E As EventArgs)
UserCtrl1.Color = "green"
UserCtrl1.Text = "This control's properties were " _
& "set programmatically!"
End Sub
</script>
<html>
<head>
<title>ASP.NET User Control Sample - Properties</title>
</head>
<body bgcolor="#FFFFFF">
<asp101samps:SomeText runat="server" />
<asp101samps:SomeText Color="red" runat="server" />
<asp101samps:SomeText Text="This is quite cool!" runat="server" />
<asp101samps:SomeText Color="blue" Text="Ain't It?" runat="server" />
<asp101samps:SomeText id="UserCtrl1" runat="server" />
</body>
</html>
還想再好些,使用者控制元件是否能夠有事件控制代碼呢?
使用者控制元件幾乎可以作任何事。下面的程式碼示範控制元件如何觸發Page_Load事件。有了事件控制代碼,就不用多寫其它的維護程式碼來控制控制元件的執行。控制元件可以自己觸發事件。
在下面的程式碼中,封裝了一個ASP的textbox控制元件。我將我的控制元件名屬性與textbox的內容掛鉤。
events.ascx
<script language="VB" runat="server">
Sub Page_Load(Src As Object, E As EventArgs)
Dim strInitialText As String = "Please Enter a Name!"
If Page.IsPostBack Then
If txtName.Text = strInitialText
txtName.Text = ""
End If
Else
txtName.Text = strInitialText
End If
End Sub
Public Property Name As String
Get
Return txtName.Text
End Get
Set
txtName.Text = Value
End Set
End Property
</script>
Name: <asp:textbox id="txtName" runat="server" />
<asp:RequiredFieldValidator ControlToValidate="txtName"
id="valtxtName" Display="Dynamic" runat=server>
Please Enter a Name!
</asp:RequiredFieldValidator>
events.aspx
<%@ Page Language="VB" ClientTarget="downlevel" %>
<%@ Register TagPrefix="asp101samps" TagName="SomeText"
Src="properties.ascx" %>
<%@ Register TagPrefix="asp101samps" TagName="TextBox"
Src="events.ascx" %>
<script language="VB" runat="server">
Sub Page_Load(Sender As Object, E As EventArgs)
txtLabel.Text = ""
' The textbox control handles it's own stuff
' in it's own Page_Load event handler.
End Sub
Sub btnSubmit_Click(Sender As Object, E As EventArgs)
' Sets the label to the textbox's text
txtLabel.Text = txtName.Name
' I don't need to worry about validation since
' my user control does it for me.
End Sub
</script>
<html>
<head>
<title>ASP.NET User Control Sample - Validation & Events</title>
</head>
<body bgcolor="#FFFFFF">
<form runat="server">
<asp101samps:TextBox id="txtName" runat="server" />
<br />
<asp:button id="btnSubmit" onClick="btnSubmit_Click"
text="Submit" runat="server" />
</form>
<asp101samps:SomeText id="txtLabel" runat="server" />
</body>
</html>
這就是關於使用者控制元件和應用的說明。無論你認為它是否簡單,它肯定比使用傳統ASP要容易。
下面可以下載本文程式碼。
http://www.ChinaOK.net/down/200204221838030.zip
當然,ASP.NET不會給你變出一個莫須有的控制元件。事實上,可以動手作自己的控制元件來取代.NET提供的控制元件。這種控制元件就是使用者控制元件,也正是本文討論的話題。
編寫第一個使用者控制元件
有人認為,知道如何使用服務端控制元件可不一定說明編寫使用者控制元件是件容易的事。
事實上,編寫一個基本使用者控制元件(有時也稱之為pagelets)並讓ASP.NET頁面象使用服務端控制元件那樣使用這些控制元件的確是件簡單的事。這裡有一個簡單示例:
basic.ascx
<p>
This is a user control... really!
</p>
這就是一個使用者控制元件!看到這裡,我想你會說我該不是喝醉了,頭腦不清楚吧。但這段程式碼的確就是易於被使用的一個使用者控制元件。儘管這個控制元件沒有作什麼事,卻是關於什麼是使用者控制元件的一個很好說明。事情並不象想像得那麼複雜。注意字尾.ascx,它告訴網頁這是一個使用者控制元件。它沒有什麼特別含義,只是不讓IIS去直接執行這段程式碼。
現在我們來建立一個使用者控制元件,看下面的例子:
basic.aspx
<%@ Page Language="VB" %>
<%@ Register TagPrefix="asp101samps" TagName="SomeText"
Src="basic.ascx" %>
<html>
<head>
<title>ASP.NET User Control Sample - Basic</title>
</head>
<body bgcolor="#FFFFFF">
<asp101samps:SomeText runat="server" />
</body>
</html>
這段程式碼輸出標準HTML頁面,顯示使用者控制元件裡的文字而不是標記。
那麼它是怎麼實現的呢?關鍵就在註冊(Register)說明。要註冊控制元件,先要定義三個屬性:
TagPrefix
定義控制元件位置的名稱空間。有了名稱空間制約,就可以在同一個網頁裡使用不同功能的同名控制元件。
TagName
指向所使用控制元件的名字。在同一個名稱空間裡的控制元件名是唯一的。控制元件名一般都表明控制元件的功能。
Src
指向控制元件的資原始檔。資原始檔使用虛路徑("control.ascx" 或 "/path/control.ascx"),不能使用物理路徑("C:/path/control.ascx.")。
控制元件註冊之後,就可以象其它服務端控制元件一樣被使用。通過定義目標字首(TagPrefix)和目標名(TagName),就可以象使用服務端內建控制元件一樣地進行使用。同時也確定了使用服務端執行(runat="server")方式。下面是網頁呼叫使用者控制元件的基本方式:
<TagPrefix:TagName runat="server" />
給使用者控制元件增加屬性並賦值
下面我給控制元件加上兩個屬性,一個是color,另一個是text。
properties.ascx
<script language="VB" runat="server">
Public Color As String = "black"
Public Text As String = "This is a user control... really!"
</script>
<p>
<font color="<%= Color %>">
<%= Text %>
</font>
</p>
這樣就可以使用和改變控制元件的色彩和文字了。可以在初始化時賦值,還可以動態地修改這二個屬性。
在同一個網頁裡可以重複呼叫這個控制元件並使用不同的屬性值:
properties.aspx
<%@ Page Language="VB" %>
<%@ Register TagPrefix="asp101samps" TagName="SomeText"
Src="properties.ascx" %>
<script language="VB" runat="server">
Sub Page_Load(Sender As Object, E As EventArgs)
UserCtrl1.Color = "green"
UserCtrl1.Text = "This control's properties were " _
& "set programmatically!"
End Sub
</script>
<html>
<head>
<title>ASP.NET User Control Sample - Properties</title>
</head>
<body bgcolor="#FFFFFF">
<asp101samps:SomeText runat="server" />
<asp101samps:SomeText Color="red" runat="server" />
<asp101samps:SomeText Text="This is quite cool!" runat="server" />
<asp101samps:SomeText Color="blue" Text="Ain't It?" runat="server" />
<asp101samps:SomeText id="UserCtrl1" runat="server" />
</body>
</html>
還想再好些,使用者控制元件是否能夠有事件控制代碼呢?
使用者控制元件幾乎可以作任何事。下面的程式碼示範控制元件如何觸發Page_Load事件。有了事件控制代碼,就不用多寫其它的維護程式碼來控制控制元件的執行。控制元件可以自己觸發事件。
在下面的程式碼中,封裝了一個ASP的textbox控制元件。我將我的控制元件名屬性與textbox的內容掛鉤。
events.ascx
<script language="VB" runat="server">
Sub Page_Load(Src As Object, E As EventArgs)
Dim strInitialText As String = "Please Enter a Name!"
If Page.IsPostBack Then
If txtName.Text = strInitialText
txtName.Text = ""
End If
Else
txtName.Text = strInitialText
End If
End Sub
Public Property Name As String
Get
Return txtName.Text
End Get
Set
txtName.Text = Value
End Set
End Property
</script>
Name: <asp:textbox id="txtName" runat="server" />
<asp:RequiredFieldValidator ControlToValidate="txtName"
id="valtxtName" Display="Dynamic" runat=server>
Please Enter a Name!
</asp:RequiredFieldValidator>
events.aspx
<%@ Page Language="VB" ClientTarget="downlevel" %>
<%@ Register TagPrefix="asp101samps" TagName="SomeText"
Src="properties.ascx" %>
<%@ Register TagPrefix="asp101samps" TagName="TextBox"
Src="events.ascx" %>
<script language="VB" runat="server">
Sub Page_Load(Sender As Object, E As EventArgs)
txtLabel.Text = ""
' The textbox control handles it's own stuff
' in it's own Page_Load event handler.
End Sub
Sub btnSubmit_Click(Sender As Object, E As EventArgs)
' Sets the label to the textbox's text
txtLabel.Text = txtName.Name
' I don't need to worry about validation since
' my user control does it for me.
End Sub
</script>
<html>
<head>
<title>ASP.NET User Control Sample - Validation & Events</title>
</head>
<body bgcolor="#FFFFFF">
<form runat="server">
<asp101samps:TextBox id="txtName" runat="server" />
<br />
<asp:button id="btnSubmit" onClick="btnSubmit_Click"
text="Submit" runat="server" />
</form>
<asp101samps:SomeText id="txtLabel" runat="server" />
</body>
</html>
這就是關於使用者控制元件和應用的說明。無論你認為它是否簡單,它肯定比使用傳統ASP要容易。
下面可以下載本文程式碼。
http://www.ChinaOK.net/down/200204221838030.zip