使CheckBoxList的Attributes屬性生效（修改微軟的一個bug）
2024-07-10 13:22:50
供稿：網友
本文將描述如何使CheckBoxList中的Item添加的Attribute在客戶端生效，CheckBoxList是一個非常好用的組件，它支持數據綁定等特性。但是他和DropDownList有同樣的一個問題，就是當我們向它們的Items里面Add項目的時候，如果希望給這些Item添加客戶端行為，這些行為并不能體現在客戶端，我們通常使用的方法如下：
HTML頁面部分如下：
<asp:CheckBoxList id="CheckBoxList1" runat="server">
<asp:ListItem Value="1">1</asp:ListItem>
<asp:ListItem Value="2">2</asp:ListItem>
<asp:ListItem Value="3">3</asp:ListItem>
</asp:CheckBoxList>
我們在Page_Load里面添加如下代碼：
foreach(ListItem item in this.CheckBoxList1.Items){
item.Attributes.Add("onclick","alert('"+item.Text+"')");
}
這樣做的目的是：當我們點擊CheckBox的時候希望alert出來我們選中的CheckBox的內容，當然還有其他的一些更有用的應用。但是實際上這段代碼是不能正常工作的。我們在客戶端點擊CheckBox的時候看不到提示信息，同樣不論你向Attributs中添加什么都不會有任何反應的。同樣的問題也存在于其他的List控件中，比如：DropDownList等。
下面是這個頁面呈現的客戶端腳本：
<table id="CheckBoxList1" border="0">
<tr><td><input id="CheckBoxList1_0" type="checkbox" name="CheckBoxList1:0" /><label for="CheckBoxList1_0">1</label></td>
</tr>
<tr><td><input id="CheckBoxList1_1" type="checkbox" name="CheckBoxList1:1" /><label for="CheckBoxList1_1">2</label></td>
</tr>
<tr><td><input id="CheckBoxList1_2" type="checkbox" name="CheckBoxList1:2" /><label for="CheckBoxList1_2">3</label></td>
</tr>
</table>
可以看出來這里并沒有我們期望的onclick事件。
下面我將提供一種方法來完善這個控件，既然是完善，那么我會保持該控件原有的所有特性并修復上面這個bug（我認為應該是一個bug），可能已經有人想到了使用什么方法，對，我將使用繼承的方式復用這個控件。并在我們的新控件上做些手腳，使它更好用，我命名這個控件名叫NewCheckBoxList。
我們首先從分析客戶端代碼開始，我們發現在服務器上寫的代碼在客戶端沒有任何表現，那么怎么才能表現出來呢？這里我將重寫該組件的Render方法，來完成最終的目的。下面就描述一下我的思路，首先我會從Render中將本來應該輸出到頁面的流，輸出到一個StringBuilder里面，這樣我就有機會編輯這個StringBuilder來完成剩下的工作，獲得這個StringBuilder之后我們將按照我們希望的邏輯來為這個字符串添加內容，當內容添加完之后將這個字符串寫到控件的輸出流中即可。
下面是控件的實現代碼：
using System;
using System;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.ComponentModel;
using System.Text;
namespace Cuike519.Web.UI.WebControls {
namespace Cuike519.Web.UI.WebControls {
/// <summary>
/// Summary description for NewCheckBoxList.
/// </summary>
[DefaultProperty("Text"),
ToolboxData("<{0}:NewCheckBoxList runat=server></{0}:NewCheckBoxList>")]
public class NewCheckBoxList : System.Web.UI.WebControls.CheckBoxList {
protected override void Render(HtmlTextWriter writer) {
protected override void Render(HtmlTextWriter writer) {
StringBuilder sb = new StringBuilder();
System.IO.TextWriter tw = new System.IO.StringWriter(sb);
HtmlTextWriter OriginalStream = new HtmlTextWriter(tw);
base.Render(OriginalStream);
string s = sb.ToString();
int start = 0;
int end = s.Length;
for(int i = 0;i< this.Items.Count;i++){
start = s.IndexOf("<input",start,end-start);
StringBuilder sbItemAttribute = new StringBuilder();
this.Items[i].Attributes.Render(new HtmlTextWriter(new System.IO.StringWriter(sbItemAttribute)));
s = s.Insert(start+7,sbItemAttribute.ToString()+" ");
start = s.IndexOf("/>",start,s.Length-start);
end += sbItemAttribute.Length+1;
}
writer.Write(s);
}
}
}
代碼說明如下：
我將構造一個StringBuilder來保存該控件呈現的內容（這個內容并不完整需要修改），我們利用base.Render將原始流寫到sb里面，接著會獲得其字符串，然后我們會在整個字符串中的指定位置查找對應的input，這里的算法應該還可以優化，有興趣的網友可以試試。我會找到上一個input結尾的/>作為下一個查找的開始。在找到字符串之后我將利用item.Attribute的Render方法將我們在葉面中添加的內容輸出到一個新的StringBuilder中（過程類似前面），接著我們會將這個輸出寫到原始流字符種合適的位置。到此控件算是修改完成了，下面是測試結果：
我們在使用該控件的頁面中添加一個下面的指令：
<%@ Register TagPrefix="ck" Namespace="Cuike519.Web.UI.WebControls" Assembly="Test" %>
指明一些必要的參數，這里的Test就是我的測試工程生成的Assembly。頁面的控件部分如下：
<ck:NewCheckBoxList id="NewCheckBoxList1" runat="server">
<asp:ListItem Value="a">a</asp:ListItem>
<asp:ListItem Value="b">b</asp:ListItem>
<asp:ListItem Value="c">c</asp:ListItem>
</ck:NewCheckBoxList>
我們在頁面的Load寫上面同樣的代碼：
foreach(ListItem item in this.NewCheckBoxList1.Items){
item.Attributes.Add("onclick","alert('"+item.Text+"')");
}
同樣的代碼只是更換了控件，讓我們看看運行效果，下面是產生的客戶端腳本：
<table id="NewCheckBoxList1" border="0">
<tr><td><input onclick="alert('a')" id="NewCheckBoxList1_0" type="checkbox" name="NewCheckBoxList1:0" /><label for="NewCheckBoxList1_0">a</label></td>
</tr>
<tr><td><input onclick="alert('b')" id="NewCheckBoxList1_1" type="checkbox" name="NewCheckBoxList1:1" /><label for="NewCheckBoxList1_1">b</label></td>
</tr>
<tr><td><input onclick="alert('c')" id="NewCheckBoxList1_2" type="checkbox" name="NewCheckBoxList1:2" /><label for="NewCheckBoxList1_2">c</label></td>
</tr>
</table>
是不是和上一個不一樣？J 同樣的方法也適用于DropDownList等組件。
下面是NewDropDownList實現的部分代碼，替換NewCheckBoxList的對應部分即可：
for(int i = 0;i< this.Items.Count;i++){
start = s.IndexOf("<option",start,end-start);
StringBuilder sbItemAttribute = new StringBuilder();
this.Items[i].Attributes.Render(new HtmlTextWriter(new System.IO.StringWriter(sbItemAttribute)));
s = s.Insert(start+7,sbItemAttribute.ToString()+" ");
start = s.IndexOf("</option>",start,s.Length-start);
end += sbItemAttribute.Length+1;
}
該文章靈感來源于CSDN的網友提問。
