列表控件示例:HeadlineList
列表控件示例
數據綁定控件通常為列表控件。列表控件通過為它的主框架邊界內的每個綁定數據項重復固定的模板,生成它自己的用戶界面。例如,CheckBoxList 控件只是為每個綁定數據項重復 CheckBox 控件。同樣,DropDownList 控件遍歷它的數據源,并且在 < select > 父標記內創建新的 < option > 元素。除了列表控件以外,ASP.NET 還提供了迭代控件。它們有什么不同?
列表控件和迭代控件的不同之處在于被應用于每個數據項的可重復模板允許具有的自定義級別。像 CheckBoxList 控件一樣,Repeater 控件遍歷綁定數據項并應用用戶定義的模板。Repeater(以及更完善的 DataList 控件)極為靈活,但是在使代碼保持模塊化和分層化方面不能提供多少幫助。要使用 Repeater,您需要在該頁(或外部用戶控件)中定義模板,并使用 ASPX 源中的數據綁定屬性。它是快速、有效的,有時還是必要的,但肯定不是整潔和優雅的。
在 ASP.NET 1.x 中,所有列表控件都從 ListControl(它是表 1 中唯一一個已經在 1.x 中定義的類)繼承。讓我們進入編碼猴子模式,并且開始練習使用 ASP.NET 2.0 中的數據綁定控件。我將首先生成一個 HeadlineList 控件,以便為每個數據項呈現兩行數據綁定文本。此外,該控件還將具備一些布局功能,例如,垂直或水平呈現。
列表控件示例:HeadlineList 示例控件
正如前面提到的那樣,ListControl 是 ASP.NET 1.x 和 2.0 中所有列表控件的基類。非常令人愉快的是,可以用一種非常平滑的方式將在此為 ASP.NET 2.0 編寫的 HeadlineList 控件向后移植到 ASP.NET 1.x。出于某種原因,當需要生成標題列表時,人們的大腦中涌現的第一個想法往往是使用 Repeater。的確,Repeater 會使這一工作變得非常簡單。
- < asp:Repeater runat="server">
- < HeaderTemplate>
- < table>
- < /HeaderTemplate>
- < ItemTemplate>
- < tr>< td>
- < %# DataBinder.Eval(Container.DataItem, "Title") %>
- < hr>
- < %# DataBinder.Eval(Container.DataItem, "Abstract") %>
- < /td>< /tr>
- < /ItemTemplate>
- < FooterTemplate>
- < /table>
- < /FooterTemplate>
- < /asp:Repeater>
這段代碼有什么問題?或者更準確地說,這段代碼中有哪些可以改進的地方?
注:在 ASP.NET 2.0 中,您可以將 DataBinder.Eval(Container.DataItem, field) 替換為一個較短的表達式,該表達式受益于 Page 類上的一個新的公共方法 — Eval。這一新的表達式類似于 Eval(field)。在內部,Eval 調用 DataBinder 類上的靜態 Eval 方法,并且確定要使用的正確綁定上下文。
字段的名稱在 ASPX 頁中硬編碼。可以實現可重用性,但只能通過剪切和粘貼實現。您所添加的用于使 Repeater 的行為更加豐富多彩的代碼越多,對該解決方案及其跨越頁和項目的可重用性的危害就越大。如果標題列表控件恰恰是您需要的東西,則請改而嘗試以下方法。
- public class HeadlineList : ListControl, IRepeatInfoUser
- {
- :
- }
ListControl 是列表控件的基類(它位于與 CheckBoxList、DropDownList 和類似控件相同的系列中);IRepeatInfoUser 是上述大多數控件加以實現以便用水平或垂直方式在列和行中呈現的幾乎不為人所知的界面。請注意,ListControl 和 IRepeatInfoUser 還存在于 ASP.NET 1.x 中,并且以幾乎與 2.0 相同的方式工作。
列表控件是圍繞一個要重復的控件生成的;該控件(或控件圖)是一個類屬性,并且在加載時實例化以節省一些 CPU 時間。以下為私有 ControlToRepeat 屬性的實現。
- private Label _controlToRepeat;
- private Label ControlToRepeat
- {
- get
- {
- if (_controlToRepeat == null)
- {
- _controlToRepeat = new Label();
- _controlToRepeat.EnableViewState = false;
- Controls.Add(_controlToRepeat);
- }
- return _controlToRepeat;
- }
- }
在該示例中,要重復的控件(標題)是一個在首次讀取時實例化的 Label。HeadlineList 控件還應當向用戶提供通過多種屬性(如 RepeatLayout、RepeatColumns 和 RepeatDirection)影響外觀的方式。很多標準列表控件上都定義了這些屬性,因此開發人員不應該對它們感到陌生。它們的實現是類似的,并且看起來像下面的代碼。
- public virtual RepeatDirection RepeatDirection
- {
- get
- {
- object o = ViewState["RepeatDirection"];
- if (o != null)
- return (RepeatDirection) o;
- return RepeatDirection.Vertical;
- }
- set
- {
- ViewState["RepeatDirection"] = value;
- }
- }
為完成 HeadlineList 控件而需要編寫的另一段代碼以呈現為中心。IRepeatInfoUser 接口對您可以用來控制呈現過程的各種屬性進行計數。這方面的屬性示例有 HasHeader、HasFooter 和 HasSeparator 布爾型屬性。您可以像實現其他任何普通屬性一樣實現這些屬性,并且根據需要在 RenderItem 接口方法中使用它們。
- public void RenderItem(ListItemType itemType, int repeatIndex,
- RepeatInfo repeatInfo, HtmlTextWriter writer)
- {
- string format = "< b>{0}< /b>< hr style='solid 1px black'>{1}";
- Label lbl = ControlToRepeat;
- int i = repeatIndex;
- lbl.ID = i.ToString();
- string text = String.Format(format, Items[i].Text, Items[i].Value);
- lbl.Text = text;
- lbl.RenderControl(writer);
- }
RenderItem 對向頁提供的輸出承擔最終的責任。它獲得要重復的控件,并且將其呈現到標記中。RenderItem 是從 Render 中調用的。
- protected override void Render(HtmlTextWriter writer)
- {
- if (Items.Count >0)
- {
- RepeatInfo ri = new RepeatInfo();
- Style controlStyle = (base.ControlStyleCreated
- ? base.ControlStyle : null);
- ri.RepeatColumns = RepeatColumns;
- ri.RepeatDirection = RepeatDirection;
- ri.RepeatLayout = RepeatLayout;
- ri.RenderRepeater(writer, this, controlStyle, this);
- }
- }
RepeatInfo 是一個 Helper 對象,它經過專門設計,以便通過重復現有的控件圖來生成新控件。以上就是所需的全部代碼。讓我們準備一個示例頁,并測試該控件。
- < expo:headlinelist id="HeadlineList1" runat="server"
- repeatlayout="Table" repeatdirection="Vertical" repeatcolumns="2"
- datatextfield="LastName" datavaluefield="Notes" />
圖 2 顯示了該控件的工作方式。
列表控件示例: HeadlineList 數據綁定控件
該控件在設計時工作正常,并且不需要插入其他任何代碼。然而,這段代碼的最令人愉快的邊界效應并非免費的設計時支持。對我來說,它簡直太美妙了,因為它能夠使用 ADO.NET 數據源對象(例如,DataTable 或 DataSet)和數據源組件(如 SqlDataSource)。您可以取走這段代碼,將其編譯為 ASP.NET 1.x 項目,而它就可以使用基于 IEnumerable 的數據源。如果將這段代碼引入到 ASP.NET 2.0 項目中,則它無須更改就同樣可以使用數據源對象。
這一事實的意義是什么?
在 ASP.NET 1.x 中,ListControl 類是一個令人愉快的例外 — 但仍然是一個例外。在 ASP.NET 2.0 中,您可以使用類似的簡單但有效的方法來生成任何數據綁定控件。在這樣做的時候,您可以利用合并了大部分復雜性并且將大多數已知的最佳做法硬編碼的新基類。
【編輯推薦】