ASP.NET 2.0数据绑定控件:管理自定义集合
ListControl 是一个过于专用的类,它以不受您控制的固定方式执行数据绑定 — 除非您重写诸如 PerformSelect、OnDataBinding 和 PerformDataBinding 之类的方法。它还提供了预定义的 Items 集合属性。让我们在 ASP.NET 2.0 中的更低级别处理数据绑定,并且设计具有下列功能的 ButtonList 控件:
◆使用自定义集合类来保留组成项
◆用自定义方式管理视图状态
ButtonList 控件是另一个为每个绑定数据项输出按钮的列表控件。您可以让它从 ListControl 继承;而且,您可以获得 HeadlineList 的源代码,将 Label 替换为 Button,而它仍然应当正常工作。这一次,我将采用一种不同的方法来说明 DataBoundControl 的行为。为简单起见,我仍将跳过 IRepeatInfoUser 接口。
- public class ButtonList : System.Web.UI.WebControls.DataBoundControl
- {
- :
- }
标题和命令名称表现了每个按钮的性质。该信息是通过几个自定义属性(如 DataTextField 和 DataCommandField)从绑定数据源中获得的。您可以容易地添加类似的属性,以提供数据绑定工具提示,甚至提供 URL。
- public virtual string DataCommandField
- {
- get
- {
- object o = ViewState["DataCommandField"];
- if (o == null)
- return "";
- return (string)o;
- }
- set { ViewState["DataCommandField"] = value; }
- }
所发现的有关每个绑定按钮的所有信息都被填充到一个通过 Items 属性公开的自定义对象集合中。(请注意,Items 只是该属性的标准、惯用而任意的名称。)
- [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
- [PersistenceMode(PersistenceMode.InnerProperty)]
- public virtual ButtonItemCollection Items
- {
- get
- {
- if (_items == null)
- {
- _items = new ButtonItemCollection();
- if (base.IsTrackingViewState)
- _items.TrackViewState();
- }
- return _items;
- }
- }
Items 集合是自定义 ButtonItemCollection 类的实例 — ButtonItem 对象的集合。ButtonItem 类只是存储了有关绑定按钮的关键信息 — Text 和 CommandName 属性,外加几个构造函数以及 ToString 方法。ButtonItem 类是作为普通列表控件的 ListItem 类的对等物。下面是一个示例。
- public class ButtonItem
- {
- private string _text;
- private string _command;
- public ButtonItem(string text, string command) {
- _text = text;
- _command = command;
- }
- public string Text {
- get {return _text;}
- set {_text = value;}
- }
- public string CommandName {
- get { return _command; }
- set { _command = value; }
- }
- public override string ToString() {
- return "Button [" + Text + "]";
- }
- }
现在,如何创建 ButtonItem 对象的集合呢?在 ASP.NET 1.x 中,您必须生成一个从 CollectionBase 继承的自定义集合类,并且起码重写几个方法。然而,自定义集合只是围绕 ArrayList 对象的包装而已,在访问速度方面并没有任何真正的优势。实际上,仍然需要进行转换。.NET 2.0 中的泛型提供了真正的转折点。要生成 ButtonItem 对象集合,您需要以下代码:
- public class ButtonItemCollection : Collection < ButtonItem>
- {
- }
并且,它的性能也会更好,因为编译器在幕后完成了某些工作。ButtonList 控件只需要两个被重写的方法:Render 和 PerformDataBinding。Render 假定 Items 集合被填充;因此,它只是进行迭代并输出标记代码。
- protected override void Render(HtmlTextWriter writer)
- {
- for(int i=0; i< } btn.RenderControl(writer); btn.CommandName="item.CommandName;" btn.Text="item.Text;" Button(); btn="new" Button item="Items[i];" ButtonItem { i++)>
ASP.NET 2.0数据绑定控件:Items集合的重要性
Items 集合为什么如此重要?它可以帮助您获得两个结果。首先,您可以用手动添加的项填充该列表控件。其次,一旦在视图状态中持久保存该集合,您就可以在回发时重新生成该控件的用户界面,而无须绑定到数据。在进行数据绑定时,Items 集合是在何处以及由谁填充的呢?这需要用到 PerformDataBinding。该方法获得一个可枚举的数据列表(无论原始数据源是什么)并使用它来填充 Items 集合。
- protected override void PerformDataBinding(IEnumerable dataSource)
- {
- base.PerformDataBinding(dataSource);
- string textField = DataTextField;
- string commandField = DataCommandField;
- if (dataSource != null) {
- foreach (object o in dataSource)
- {
- ButtonItem item = new ButtonItem();
- item.Text = DataBinder.GetPropertyValue(o, textField, null);
- item.CommandName = DataBinder.GetPropertyValue(o,
- DataCommandField, null);
- Items.Add(item);
- }
- }
- }
每当需要进行数据绑定时,该方法都能够确保 Items 集合被填充。在回发时会发生什么?在这种情况下,必须根据视图状态重新构建 Items 集合。您可以通过 IStateManager 接口上的方法赋予自定义集合类这一能力。以下为该接口的关键方法:
- public void LoadViewState(object state)
- {
- if (state != null) {
- Pair p = (Pair) state;
- Clear();
- string[] rgText = (string[])p.First;
- string[] rgCommand = (string[])p.Second;
- for (int i = 0; i < rgText.Length; i++)
- Add(new ButtonItem(rgText[i], rgCommand[i]));
- }
- }
- public object SaveViewState()
- {
- int numOfItems = Count;
- object[] rgText = new string[numOfItems];
- object[] rgCommand = new string[numOfItems];
- for (int i = 0; i < numOfItems; i++) {
- rgText[i] = this[i].Text;
- rgCommand[i] = this[i].CommandName;
- }
- return new Pair(rgText, rgCommand);
- }
该类使用一个 Pair 对象(一种经过优化的 2 位置数组)将自身序列化为视图状态。您需要创建两个对象数组,以便保留每个按钮的文本和命令名称。这两个数组随后被成对打包并插入到该视图状态中。当还原该视图状态时,会将该数组对拆包,并且使用先前存储的信息重新填充 Items 集合。使用该方法要比使 ButtonItem 类可序列化更可取,因为传统的二进制格式化程序的性能(在空间和时间这两个方面)更差。
然而,向集合中添加视图状态支持还不够。还必须增强 ButtonList 控件以利用集合的序列化功能。您可以重写控件类上的 LoadViewState 和 SaveViewState。
- protected override void LoadViewState(object savedState)
- {
- if (savedState != null) {
- Pair p = (Pair) savedState;
- base.LoadViewState(p.First);
- Items.LoadViewState(p.Second);
- }
- else
- base.LoadViewState(null);
- }
- protected override object SaveViewState()
- {
- object baseState = base.SaveViewState();
- object itemState = Items.SaveViewState();
- if ((baseState == null) && (itemState == null))
- return null;
- return new Pair(baseState, itemState);
- }
控件的视图状态由两个元素组成:默认控件的视图状态以及 Items 集合。这两个对象被打包到 Pair 对象中。除了 Pair 对象以外,您还可以使用 Triplet 对象(包含三个对象的数组),或者使用 Pair 或 Triplet 对组成任意数量的对象。
以这种方式设计的自定义集合还可以在设计时满足需要。Visual Studio 2005 中嵌入的默认集合编辑器可以识别该集合并弹出如图 3 所示的对话框。
ASP.NET 2.0数据绑定控件:设计时的 ButtonList Items 集合
值得说明的是,在 ASP.NET 2.0 中,某些数据绑定控件使您可以将数据绑定项与以编程方式通过 Items 集合添加的项分开。布尔型的 AppendDataBoundItems 属性用于控制该控件的编程接口的这一方面。该属性在 ListControl(而非 DataBoundControl)上定义,并且默认为 false。
【编辑推荐】