ASP.NET 魔法學院

撰寫 UserControl 的事件

相對於 ServerControl 來說，UserControl 是相當容易上手的，利用拖曳現有控制項就可以組合成複雜的控制項。
一般 UserControl 的撰寫方式跟頁面差不多，不過 UserControl 有時需要提供一些事件，讓使用這個 UserControl 的頁面可以在此事件中撰寫相關的程式碼，以下我們就會示範如果撰寫 UserControl 的事件。

首先撰寫一個 Toolbar 的 UserControl，Toolbar 上具有「首筆」、「上筆」、「下筆」、「末筆」四個按鈕，當按下按鈕時會引發 Click 事件，並可由事件引數的 e.CommandName 得知那個按鈕引發此事件。

Toolbar.ascx 的程式碼及畫面如下

<%@ Control Language="VB" AutoEventWireup="false" CodeFile="Toolbar.ascx.vb" Inherits="Toolbar" %> <asp:Button ID="btnMoveFirst" runat="server" CommandName="MoveFirst" Text="首筆" /> <asp:Button ID="btnMovePrevious" runat="server" CommandName="MovePrevious" Text="上筆" /> <asp:Button ID="btnMoveNext" runat="server" CommandName="MoveNext" Text="下筆" /> <asp:Button ID="btnMoveLast" runat="server" CommandName="MoveLast" Text="末筆" />

Toolbar.ascx.vb 的程式碼如下

Partial Class Toolbar Inherits System.Web.UI.UserControl ''' <summary> ''' Toolbar 控制項的 Click 事件引數。 ''' </summary> Public Class ClickEventArgs Inherits System.EventArgs Dim FCommandName As String = String.Empty ''' <summary> ''' 按鈕命令。 ''' </summary> Public Property CommandName() As String Get Return FCommandName End Get Set(ByVal value As String) FCommandName = value End Set End Property End Class ''' <summary> ''' 按下工具列按鈕引發的事件。 ''' </summary> Public Event Click(ByVal sender As Object, ByVal e As ClickEventArgs) ''' <summary> ''' 引發 Click 事件。 ''' </summary> Public Overloads Sub RaiseClickEvent(ByVal e As ClickEventArgs) RaiseEvent Click(Me, e) End Sub ''' <summary> ''' 所有按鈕的事件處理函式。 ''' </summary> Protected Sub Button_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles btnMoveFirst.Click, btnMovePrevious.Click, btnMoveNext.Click, btnMoveLast.Click Dim oEventArgs As New ClickEventArgs() '取得作用按鈕的 CommandName oEventArgs.CommandName = CType(sender, Button).CommandName '引發 Click 事件 RaiseClickEvent(oEventArgs) End Sub End Class

在 Toolbar.ascx.vb中定義了 Click 事件，Click 事件引數為 ClickEventArgs，ClickEventArgs 具有 CommandName 屬性，用來識別按鈕命令。當 Toolbar 按下按鈕時，會進 Button_Click 事件處理函式，在此函式中取得作用按鈕的 CommandName，並引發 Toolbar 的 Click 事件。

接下來就是檢驗成果的時候，將 Toolbar UserControl 拖曳至頁面上，切換至頁面的程式碼 (*.aspx.vb)，在控制項清單中選取 Toolbar，在右方的事件清單中，就可以看到在 Toolbar 定義的 Click 事件了。

在 Toolbar UserControl 的 Click 事件中，撰寫如下程式碼，當按下按鈕時就會輸出對應的 CommandName。

Partial Class _Default Inherits System.Web.UI.Page Protected Sub Toolbar1_Click(ByVal sender As Object, ByVal e As Toolbar.ClickEventArgs) Handles Toolbar1.Click Me.Response.Write(e.CommandName) End Sub End Class

程式碼下載：UserControlEvent.rar