如何在Sitecore中动态创建WizardFormPage并运行时加载控件？

一、动态填充已有页面控件的正确实现 #

ActivePageChanging事件触发时，页面控件树已初始化完成，直接添加控件无法被渲染。正确流程是通过状态存储+页面加载阶段添加控件：

1. 在ActivePageChanging中保存动态控件的数据源/状态到Sitecore向导的ServerProperties（跨回传数据容器）
2. 重写OnLoad方法，在页面加载阶段读取状态、判断当前激活页面后动态添加控件

示例代码：

protected override bool ActivePageChanging(string page, ref string newpage)
{
    if (newpage.Equals(Consts.PrototypeDetailsPageId))
    {
        if (IsFormItemSelected(out var formItem))
        {
            // 保存选中项到ServerProperties，供后续加载使用
            ServerProperties["SelectedFormItem"] = formItem;
        }
        else
        {
            SheerResponse.Alert("必须选择一个表单项");
            return false;
        }
    }
    return base.ActivePageChanging(page, ref newpage);
}

protected override void OnLoad(EventArgs e)
{
    base.OnLoad(e);
    if (!Page.IsPostBack) return;

    // 仅在当前激活页为目标页时处理
    if (ActivePage == Consts.PrototypeDetailsPageId)
    {
        if (ServerProperties.TryGetValue("SelectedFormItem", out var formItemObj) && formItemObj is Item formItem)
        {
            // 动态添加控件到指定容器
            PrototypeDetailsPanel0.Controls.Add(new Literal($"选中的表单项：{formItem.DisplayName}"));
        }
    }
}

二、动态新增全新向导页面的方法 #

如果需要添加XML中未预定义的全新页面，需修改向导的Pages集合并强制整体刷新：

1. 创建WizardDialogBaseXmlControl实例，设置唯一ID并构建页面内容
2. 将新页面加入this.Pages集合，指定下一页为新页面ID
3. 调用SheerResponse.Refresh(this)强制刷新整个向导

示例代码：

protected override bool ActivePageChanging(string page, ref string newpage)
{
    // 自定义条件判断是否需要新增页面
    if (newpage.Equals(Consts.TriggerPageId) && NeedAddCustomPage())
    {
        // 构建动态页面
        var customPage = new WizardDialogBaseXmlControl();
        customPage.ID = "DynamicCustomPage";
        
        // 给页面添加控件（可加载XML片段或直接创建服务器控件）
        var contentPanel = new Panel();
        contentPanel.Controls.Add(new Literal("这是动态生成的自定义向导页面"));
        customPage.Controls.Add(contentPanel);

        // 将新页面加入向导页面集合
        this.Pages.Add(customPage);
        // 设置下一页为动态页面
        newpage = customPage.ID;

        // 强制刷新向导，让新页面生效
        SheerResponse.Refresh(this);
    }
    return base.ActivePageChanging(page, ref newpage);
}

三、核心注意事项 #

• 控件生命周期：WebForms控件必须在Page_Init或Page_Load阶段加入控件树，ActivePageChanging属于事件触发阶段，此时添加控件已错过渲染时机
• 状态存储：优先使用Sitecore提供的ServerProperties存储跨回传数据，不要依赖ViewState
• 刷新逻辑：新增页面必须调用SheerResponse.Refresh(this)整体刷新向导，Redraw()仅能刷新单个控件，无法识别页面集合的变化

内容的提问来源于stack exchange，提问作者Igor