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

ASP.NET 伺服器控件開發基礎 (8)：複合控件事件處理與 IPostBackEventHandler 實作

編輯：關於ASP.NET

前言：複合控件事件處理的兩種模式

複合控件包含子控件 (如 Button、LinkButton)，子控件事件需向外暴露。ASP.NET 提供兩種模式：直接處理 (控件內部處理，不暴露事件) 與 事件包裝 (定義自訂事件，包裝子控件事件並向外傳遞)。本篇深度解析兩種模式實作與 IPostBackEventHandler 核心機制。

模式一：直接處理子控件事件

適用場景

內部邏輯封裝，外部無需感知
簡單導航、分頁、模式切換
不需向頁面傳遞資料

實作範例：簡單導航控件


public class SimpleNavigator : Control, IPostBackEventHandler
{
    private string _previousText = "上一頁";
    private string _nextText = "下一頁";
    
    public string PreviousText
    {
        get => _previousText;
        set => _previousText = value;
    }
    
    public string NextText
    {
        get => _nextText;
        set => _nextText = value;
    }
    
    // IPostBackEventHandler 實作
    public void RaisePostBackEvent(string eventArgument)
    {
        switch (eventArgument)
        {
            case "Previous":
                PreviousText = "你點擊了上一頁按鈕";
                break;
            case "Next":
                NextText = "你點擊了下一頁按鈕";
                break;
        }
    }
    
    protected override void Render(HtmlTextWriter writer)
    {
        // Previous 按鈕
        writer.AddAttribute(HtmlTextWriterAttribute.Onclick, 
            Page.ClientScript.GetPostBackEventReference(this, "Previous"));
        writer.RenderBeginTag(HtmlTextWriterTag.Button);
        writer.Write(PreviousText);
        writer.RenderEndTag();
        
        writer.Write(" ");
        
        // Next 按鈕
        writer.AddAttribute(HtmlTextWriterAttribute.Onclick, 
            Page.ClientScript.GetPostBackEventReference(this, "Next"));
        writer.RenderBeginTag(HtmlTextWriterTag.Button);
        writer.Write(NextText);
        writer.RenderEndTag();
    }
}

關鍵點解析

實作 IPostBackEventHandler：宣告控件接收回發事件
RaisePostBackEvent(string eventArgument)：核心處理方法，eventArgument 區分不同動作
Page.ClientScript.GetPostBackEventReference(this, argument)：產生客戶端 __doPostBack('ControlID', 'Argument') 腳本
渲染時注入 onclick：將回發腳本綁定至按鈕

模式二：事件包裝與自訂事件參數

適用場景

需向頁面傳遞資料 (如選中的項目、輸入值)
支援多種命令類型 (編輯、刪除、選取、自訂命令)
符合 ASP.NET 內建控件事件模式 (如 GridView.RowCommand)

核心類別定義


// 1. 自訂事件參數：攜帶命令資訊與資料鍵
public class NavigatorCommandEventArgs : CommandEventArgs
{
    public int ItemIndex { get; }
    public object DataKey { get; }
    
    public NavigatorCommandEventArgs(int itemIndex, object dataKey, CommandEventArgs originalArgs)
        : base(originalArgs)
    {
        ItemIndex = itemIndex;
        DataKey = dataKey;
    }
}

// 2. 委托定義
public delegate void NavigatorCommandEventHandler(object sender, NavigatorCommandEventArgs e);

複合控件完整實作


public class AdvancedNavigator : CompositeControl, IPostBackEventHandler
{
    // 子控件
    private Button _btnFirst, _btnPrev, _btnNext, _btnLast;
    private Label _lblCurrentPage;
    
    // 屬性
    public int CurrentPageIndex { get; private set; } = 0;
    public int TotalPages { get; set; } = 1;
    public string DataKeyField { get; set; }
    
    // 事件
    public event NavigatorCommandEventHandler NavigateCommand;
    public event EventHandler PageIndexChanged;
    
    protected override void CreateChildControls()
    {
        Controls.Clear();
        
        _btnFirst = new Button { ID = "btnFirst", Text = "<<", CommandName = "First" };
        _btnPrev = new Button { ID = "btnPrev", Text = "<", CommandName = "Prev" };
        _lblCurrentPage = new Label { ID = "lblCurrentPage" };
        _btnNext = new Button { ID = "btnNext", Text = ">", CommandName = "Next" };
        _btnLast = new Button { ID = "btnLast", Text = ">>", CommandName = "Last" };
        
        // 統一事件處理
        _btnFirst.Command += ChildButton_Command;
        _btnPrev.Command += ChildButton_Command;
        _btnNext.Command += ChildButton_Command;
        _btnLast.Command += ChildButton_Command;
        
        // 佈局
        Table table = new Table();
        TableRow row = new TableRow();
        row.Cells.Add(new TableCell { Controls = { _btnFirst } });
        row.Cells.Add(new TableCell { Controls = { _btnPrev } });
        row.Cells.Add(new TableCell { Controls = { _lblCurrentPage }, HorizontalAlign = HorizontalAlign.Center });
        row.Cells.Add(new TableCell { Controls = { _btnNext } });
        row.Cells.Add(new TableCell { Controls = { _btnLast } });
        table.Rows.Add(row);
        
        Controls.Add(table);
        ChildControlsCreated = true;
        
        UpdateDisplay();
    }
    
    private void ChildButton_Command(object sender, CommandEventArgs e)
    {
        // 包裝為自訂事件參數
        object dataKey = GetDataKey(CurrentPageIndex);
        NavigatorCommandEventArgs args = new NavigatorCommandEventArgs(CurrentPageIndex, dataKey, e);
        
        // 觸發自訂事件 (供頁面處理)
        OnNavigateCommand(args);
        
        // 內部預設行為
        if (!args.Handled) // 假設加入 Handled 屬性
        {
            ExecuteNavigation(e.CommandName);
        }
    }
    
    protected virtual void OnNavigateCommand(NavigatorCommandEventArgs e)
    {
        NavigateCommand?.Invoke(this, e);
    }
    
    private void ExecuteNavigation(string commandName)
    {
        int oldIndex = CurrentPageIndex;
        switch (commandName)
        {
            case "First": CurrentPageIndex = 0; break;
            case "Prev": CurrentPageIndex = Math.Max(0, CurrentPageIndex - 1); break;
            case "Next": CurrentPageIndex = Math.Min(TotalPages - 1, CurrentPageIndex + 1); break;
            case "Last": CurrentPageIndex = TotalPages - 1; break;
        }
        
        if (CurrentPageIndex != oldIndex)
        {
            UpdateDisplay();
            OnPageIndexChanged(EventArgs.Empty);
        }
    }
    
    private void UpdateDisplay()
    {
        EnsureChildControls();
        _lblCurrentPage.Text = $"{CurrentPageIndex + 1} / {TotalPages}";
        _btnFirst.Enabled = _btnPrev.Enabled = CurrentPageIndex > 0;
        _btnNext.Enabled = _btnLast.Enabled = CurrentPageIndex < TotalPages - 1;
    }
    
    protected virtual void OnPageIndexChanged(EventArgs e)
    {
        PageIndexChanged?.Invoke(this, e);
    }
    
    // IPostBackEventHandler: 允許直接回發 (不透過子控件 Command)
    public void RaisePostBackEvent(string eventArgument)
    {
        // 支援直接呼叫 __doPostBack('Navigator1', 'First')
        if (Enum.TryParse(eventArgument, out NavigationCommand cmd))
        {
            ExecuteNavigation(cmd.ToString());
        }
    }
    
    private enum NavigationCommand { First, Prev, Next, Last }
    
    private object GetDataKey(int index)
    {
        // 實作根據 DataKeyField 取得鍵值
        return null;
    }
}

頁面使用範例

IPostBackEventHandler 進階：多控件回發區分

問題：同一頁面多個相同控件

所有控件共用 __doPostBack，如何區分？

解決：UniqueID 作為目標


// GetPostBackEventReference 自動使用控件 UniqueID
string script = Page.ClientScript.GetPostBackEventReference(this, "First");
// 生成: __doPostBack('ctl00$ContentPlaceHolder1$Navigator1', 'First')

// 伺服器端接收時，ASP.NET 依據 UniqueID 找到對應控件實例
// 呼叫該實例的 RaisePostBackEvent("First")

手動產生回發腳本 (進階控制)


protected override void Render(HtmlTextWriter writer)
{
    EnsureChildControls();
    
    // 取得回發腳本參考
    string postBackRef = Page.ClientScript.GetPostBackEventReference(this, "");
    // postBackRef = "__doPostBack('Navigator1','')"
    
    // 為每個按鈕產生特定參數腳本
    string firstScript = postBackRef.Replace("''", "'First'");
    string prevScript = postBackRef.Replace("''", "'Prev'");
    // ...
    
    _btnFirst.Attributes["onclick"] = firstScript;
    _btnPrev.Attributes["onclick"] = prevScript;
    // ...
}

事件模式比較總結

維度	直接處理模式	事件包裝模式
複雜度	低	中高
外部可擴展性	無	高 (頁面可攔截、擴展)
資料傳遞	無 (僅透過屬性)	豐富 (事件參數攜帶資料)
符合內建控件慣例	否	是 (如 RowCommand, ItemCommand)
效能	略優 (無事件包裝開銷)	可忽略差異
適用控件類型	簡單導航、分頁、模式切換	資料綁定控件、複雜互動控件