您现在的位置：程式碼之家 >> 編程語言 > >> .NET 網頁程式設計 >> ASP.NET 基礎 >> 關於ASP.NET

ASP.NET 2.0 復合控制項事件實作：包含法與冒泡法完整解析

編輯：關於ASP.NET

復合控制項事件的核心挑戰

復合控制項封裝多個子控制項，外部無法直接存取子控制項（破壞封裝性）。因此，子控制項的事件（如 Button.Click、TextBox.TextChanged）必須「向上傳遞」為復合控制項的頂層事件，外部才能訂閱處理。這稱為事件上傳。

兩大經典實作模式

模式一：包含法

核心概念： 在 CreateChildControls 中為子控制項掛上事件處理常式，該處理常式內再呼叫復合控制項的頂層事件引發方法（OnEventName）。

關鍵步驟

定義頂層事件與委派：public event EventHandler Submit;
定義受保護的引發方法：protected virtual void OnSubmit(EventArgs e) { if (Submit != null) Submit(this, e); }
在 CreateChildControls 為子控制項掛接事件：btn.Click += new EventHandler(btn_Click);
子控制項事件處理常式呼叫頂層引發方法：void btn_Click(object s, EventArgs e) { OnSubmit(EventArgs.Empty); }

完整範例：文字框+按鈕的搜尋復合控制項

[ToolboxData("<{0}:SearchBox runat=server></{0}:SearchBox>")]
public class SearchBox : CompositeControl
{
    private TextBox txtKeyword;
    private Button btnSearch;

    public event EventHandler Search;

    protected virtual void OnSearch(EventArgs e)
    {
        if (Search != null) Search(this, e);
    }

    public string Keyword
    {
        get { EnsureChildControls(); return txtKeyword.Text; }
    }

    protected override void CreateChildControls()
    {
        txtKeyword = new TextBox { ID = "txtKeyword" };
        btnSearch = new Button { ID = "btnSearch", Text = "搜尋" };
        btnSearch.Click += new EventHandler(btnSearch_Click);
        Controls.Add(txtKeyword);
        Controls.Add(btnSearch);
    }

    void btnSearch_Click(object sender, EventArgs e)
    {
        OnSearch(EventArgs.Empty);
    }
}

使用方式

<cc:SearchBox ID="searchBox" runat="server" OnSearch="searchBox_Search" />
protected void searchBox_Search(object sender, EventArgs e)
{
    string kw = searchBox.Keyword;
    // 執行搜尋邏輯
}

模式二：事件冒泡法

核心概念： 利用 ASP.NET 控制項樹的 OnBubbleEvent 機制，子控制項引發事件時自動向上冒泡，父控制項覆寫 OnBubbleEvent 攔截並轉發為頂層事件。

關鍵步驟

子控制項呼叫 RaiseBubbleEvent(this, e)（Button、LinkButton 等內建控制項已自動處理）。
父控制項覆寫 protected override bool OnBubbleEvent(object source, EventArgs e)。
判斷事件來源與型別，呼叫頂層引發方法並回傳 true 表示已處理。

範例：同樣的 SearchBox 採用冒泡法

protected override bool OnBubbleEvent(object source, EventArgs e)
{
    if (source == btnSearch && e is CommandEventArgs)
    {
        OnSearch(EventArgs.Empty);
        return true;
    }
    return base.OnBubbleEvent(source, e);
}

此時 CreateChildControls 就不需手動掛接 btnSearch.Click，Button 的 Command 事件會自動冒泡。

兩種模式比較與選擇指南

維度	包含法	冒泡法
實作複雜度	直觀、程式碼較多	精簡、需理解冒泡機制
封裝性	父控制項明確掛接子事件	子控制項自主冒泡，父控制項被動接收
適用子控制項	任何支援事件的控制項	需支援 `RaiseBubbleEvent`（WebControl 內建）
多層嵌套	需逐層手動轉發	自動穿透多層控制項樹
效能	略優（直接呼叫）	極微小差異，可忽略

建議： 簡單復合控制項用包含法，易讀易維護；複雜、多層嵌套或需支援命令型事件（Command、RowCommand）時採用冒泡法。

進階：自訂事件引數傳遞資料

若頂層事件需傳遞資料（如搜尋關鍵字），定義繼承 EventArgs 的類別：

public class SearchEventArgs : EventArgs
{
    public string Keyword { get; private set; }
    public SearchEventArgs(string keyword) { Keyword = keyword; }
}

public event EventHandler Search;
protected virtual void OnSearch(SearchEventArgs e)
{
    if (Search != null) Search(this, e);
}

void btnSearch_Click(object sender, EventArgs e)
{
    OnSearch(new SearchEventArgs(txtKeyword.Text));
}