ASP.NET WebForms 透過 Page.LoadControl 可在執行期動態載入 .ascx 使用者控制項,適用於插件式架構、權限型 UI、多步驟精靈等場景。本文說明動態載入完整流程、ID 管理、事件繫結、ViewState 保持與常見坑點。
// 1. 載入控制項類別
UserControl uc = (UserControl)Page.LoadControl("~/Controls/MyWidget.ascx");
// 2. 指定唯一 ID (必要,否則 ViewState/事件失效)
uc.ID = "MyWidget_1";
// 3. 設定公開屬性 (若控制項有定義)
((MyWidget)uc).Title = "動態標題";
((MyWidget)uc).DataSource = GetData();
// 4. 加入容器控制項 (PlaceHolder / Panel / div runat=server)
phContainer.Controls.Add(uc);
動態控制項**必須在每次 Postback 的 Page_Init (或更早) 重新建立**,否則:
protected void Page_Init(object sender, EventArgs e) {
if (!IsPostBack) {
LoadDynamicControl(); // 首次載入
} else {
RecreateDynamicControls(); // Postback 重建
}
}
private void RecreateDynamicControls() {
// 從 Session/ViewState/隱藏欄位讀取先前建立的控制項類型/參數
var config = (ControlConfig)ViewState["DynamicControlConfig"];
if (config != null) LoadDynamicControl(config);
}
使用者控制項定義公共事件:
// MyWidget.ascx.cs
public event EventHandler SaveClicked;
protected void btnSave_Click(object sender, EventArgs e) {
SaveClicked?.Invoke(this, new WidgetEventArgs { Data = txtInput.Text });
}
頁面訂閱事件 (在重建時同步訂閱):
private void LoadDynamicControl(ControlConfig config) {
var uc = (MyWidget)LoadControl("~/Controls/MyWidget.ascx");
uc.ID = config.ControlId;
uc.SaveClicked += Uc_SaveClicked; // 訂閱
phContainer.Controls.Add(uc);
}
private void Uc_SaveClicked(object sender, WidgetEventArgs e) {
// 處理儲存邏輯
lblMessage.Text = $"儲存: {e.Data}";
}
GridView 等需資料繫結的子控制項,資料繫結邏輯需在 Page_Load (非 Postback) 或每次 Postback 執行,ViewState 只保存控制項狀態不含資料來源。public static class DynamicControlHelper {
public static T Load<T>(Control container, string virtualPath, string id, Action<T> configure = null) where T : UserControl {
T ctrl = (T)container.Page.LoadControl(virtualPath);
ctrl.ID = id;
configure?.Invoke(ctrl);
container.Controls.Add(ctrl);
return ctrl;
}
}
// 使用
var widget = DynamicControlHelper.Load(phContainer, "~/Controls/MyWidget.ascx", "Widget1", w => {
w.Title = "標題";
w.SaveClicked += Widget_SaveClicked;
});
| 現象 | 原因 | 解決 |
|---|---|---|
| Postback 後控制項消失 | 未在 Page_Init 重建 | 在 Init 階段依存狀態重建 |
| 事件不觸發 | ID 不固定 / 重建時未訂閱 | 固定 ID、重建時同步訂閱 |
| 驗證控制項不生效 | 同樣是生命週期問題 | 同上 |
| 多個同類控制項 ID 衝突 | ID 重複 | 採用 GUID 或索引產生唯一 ID |
掌握「Init 重建、固定 ID、同步訂閱」三原則,即能靈活運用動態使用者控制項打造高彈性的 WebForms 介面。