ASP.NET自定义CheckBoxList控件回发时丢失选中状态问题排查

我扩展了ASP.NET的CheckBoxList Web控件，做了适配Bootstrap 5布局的版本。控件显示正常，但回发时会丢失选中状态，而且控件的SelectedItem属性为null。

我用相同逻辑做了自定义RadioButtonList控件，却能正常工作。通过DotPeek查看发现两者继承的控件和接口完全一致，搞不懂为什么自定义RadioButtonList能维持状态，CheckBoxList却不行，网上也找不到可用示例，求解决思路。

自定义CheckBoxList控件代码（C#） #

public class Bootstrap5CheckBoxList : CheckBoxList {
    protected override void Render(HtmlTextWriter writer) {
        try {
            var selected = false;

            //var webControl = new WebControl(HtmlTextWriterTag.Div);
            //webControl.ID = ClientID;

            //webControl.RenderBeginTag(writer);

            for (int index = 0; index < Items.Count; index++) {
                var item = this.Items[index];

                //div
                writer.Indent++;
                writer.WriteBeginTag($"div class='form-check {base.CssClass}'");
                writer.Write('>');
                writer.WriteLine();

                //input
                writer.Indent++;
                writer.WriteBeginTag("input");
                writer.WriteAttribute("id", $"{this.ID}_{index}");
                writer.WriteAttribute("type", "checkbox");
                writer.WriteAttribute("name", $"{this.UniqueID}_{index}");

                var cssClass = "";

                if (item.Attributes["class"] != null) {
                    cssClass = item.Attributes["class"];
                }

                writer.WriteAttribute("class", $"form-check-input {cssClass}");
                writer.WriteAttribute("value", item.Value);
                var clientID = this.ClientID;

                if (item.Selected) {
                    if (selected) {
                        this.VerifyMultiSelect();
                    }
                    selected = true;
                    writer.WriteAttribute("checked", "checked");
                }

                if (item.Attributes.Count > 0) {
                    foreach (string key in item.Attributes.Keys) {
                        if (!"class".Equals(key)) {
                            writer.WriteAttribute(key, item.Attributes[key]);
                        }
                    }
                }
           
                if (!item.Enabled)
                    writer.WriteAttribute("disabled", "disabled");

                if (this.Page != null) {
                    this.Page.ClientScript.RegisterForEventValidation(
                        this.UniqueID,
                        item.Value);
                }

                writer.Write('>');
                writer.WriteEndTag("input");
                writer.WriteLine();

                //label
                writer.WriteBeginTag("label");
                writer.WriteAttribute("class", "form-check-label");
                writer.WriteAttribute("for", $"{this.ID}_{index}");

                writer.Write('>');
                HttpUtility.HtmlEncode(item.Text, writer);
                writer.WriteEndTag("label");
                writer.Indent--;

                writer.WriteLine();

                //Close Div
                writer.WriteEndTag("div");
                writer.WriteLine();
                writer.Indent--;


            }

            //webControl.RenderEndTag(writer);

        } catch (Exception ex) {
            throw new Exception(string.Format("{0}.{1}:{2} {3}", System.Reflection.MethodBase.GetCurrentMethod().DeclaringType.FullName, System.Reflection.MethodBase.GetCurrentMethod().Name, ex.Message, ex.StackTrace));
        }
    }
}

页面使用代码（HTML） #

<%@ Register TagPrefix="BSControls" Namespace="My.App.classes.custom_controls" Assembly="My.App" %>

<BSControls:Bootstrap5CheckBoxList ID="customCheckList" runat="server">
        <asp:ListItem Value="1">Check 1</asp:ListItem>
        <asp:ListItem Value="2">Check 2</asp:ListItem>
    </BSControls:Bootstrap5CheckBoxList>

问题核心出在表单元素的name属性设置：

• RadioButtonList原生逻辑里，所有单选按钮共享同一个name（即控件的UniqueID），回发时ASP.NET能正确识别组内选中项并映射到控件状态。
• 但你给CheckBoxList的每个复选框设置了name="{this.UniqueID}_{index}"，每个复选框的name都不一样，ASP.NET的状态机制无法将回发的表单值关联到CheckBoxList控件，导致选中状态丢失。

修复步骤 #

1. 将所有复选框的name属性统一设置为控件的UniqueID，不要加索引后缀。CheckBoxList支持多选，ASP.NET会自动处理同一name下的多个选中值。
2. 保留id属性的{this.ID}_{index}后缀，确保label的for属性能正确关联对应的复选框。

修改后的input标签关键代码片段：

//input
writer.Indent++;
writer.WriteBeginTag("input");
writer.WriteAttribute("id", $"{this.ID}_{index}");
writer.WriteAttribute("type", "checkbox");
// 关键修改：name使用控件的UniqueID，去掉索引后缀
writer.WriteAttribute("name", this.UniqueID);

var cssClass = "";

if (item.Attributes["class"] != null) {
    cssClass = item.Attributes["class"];
}

writer.WriteAttribute("class", $"form-check-input {cssClass}");
writer.WriteAttribute("value", item.Value);
// 其余代码保持不变...

额外验证点 #

• 不要重写LoadPostData方法，CheckBoxList原生的LoadPostData会处理同一name下的多个选中值，自动映射到Items的Selected属性。
• 事件注册部分RegisterForEventValidation的第一个参数保持this.UniqueID即可，无需修改。

修改完成后，回发时ASP.NET就能正确识别复选框的选中状态，SelectedItem和SelectedItems也能正常获取值。

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