萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

ASP.NET 建立具備自訂事件的使用者控制項 (User Control)

為什麼要在使用者控制項中定義事件?

使用者控制項 (`.ascx`) 封裝 UI 與邏輯,若需通知容器頁面「使用者點擊了內部按鈕」、「資料變更」等動作,必須對外公開事件,遵循「控制項觸發、頁面訂閱」模式,維持低耦合。

三步驟建立事件

  1. 定義 public event EventHandler EventName; (或自訂 EventHandler<TEventArgs>)
  2. 建立 protected virtual void OnEventName(EventArgs e) 引發方法
  3. 在內部控制項事件 (如 Button_Click) 中呼叫 OnEventName

完整範例:可點擊連結的使用者控制項

LinkClick.ascx (標記)

<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="LinkClick.ascx.cs" Inherits="Demo.Controls.LinkClick" %>
<asp:LinkButton ID="lnkAction" runat="server" OnClick="lnkAction_Click">點擊我</asp:LinkButton>

LinkClick.ascx.cs (代碼後置)

public partial class LinkClick : UserControl
{
    // 1. 公開事件
    public event EventHandler LinkClicked;

    protected void Page_Load(object sender, EventArgs e) { }

    // 2. 引發方法
    protected virtual void OnLinkClicked(EventArgs e)
    {
        LinkClicked?.Invoke(this, e); // C# 6.0 null-conditional operator
    }

    // 3. 內部按鈕點擊觸發
    protected void lnkAction_Click(object sender, EventArgs e)
    {
        OnLinkClicked(EventArgs.Empty);
    }
}

Default.aspx (容器頁面)

<%@ Register Src="~/Controls/LinkClick.ascx" TagPrefix="uc" TagName="LinkClick" %>
<uc:LinkClick ID="ucLink" runat="server" OnLinkClicked="ucLink_LinkClicked" />
<asp:Label ID="lblMsg" runat="server" />

Default.aspx.cs

protected void ucLink_LinkClicked(object sender, EventArgs e)
{
    lblMsg.Text = $"使用者於 {DateTime.Now:HH:mm:ss} 點擊了連結";
}

進階:帶參數的自訂事件

// 自訂 EventArgs
public class LinkClickEventArgs : EventArgs
{
    public string Url { get; set; }
    public int UserId { get; set; }
}

// 控制項內
public event EventHandler<LinkClickEventArgs> LinkClickedWithData;
protected virtual void OnLinkClickedWithData(LinkClickEventArgs e) => LinkClickedWithData?.Invoke(this, e);

protected void lnkAction_Click(object sender, EventArgs e)
{
    OnLinkClickedWithData(new LinkClickEventArgs { Url = "~/Detail.aspx", UserId = 123 });
}

// 頁面訂閱
protected void ucLink_LinkClickedWithData(object sender, LinkClickEventArgs e)
{
    Response.Redirect($"{e.Url}?uid={e.UserId}");
}

最佳實務提醒

  • 事件命名遵循 On[動作] (引發方法) / [動作] (事件名) 慣例。
  • 引發方法標記 virtual 允許衍生類別覆寫。
  • 使用 ?.Invoke 簡化 null 檢查,執行緒安全 (單執行緒 UI 無競爭)。
  • 避免在控制項內直接操作頁面控制項 (如 Page.FindControl),破壞封裝。
copyright © 萬盛學電腦網 all rights reserved