生成數(shù)據(jù)綁定ASP.NET復(fù)合控件

大多數(shù)復(fù)雜的服務(wù)器控件都已綁定數(shù)據(jù)（也可能已經(jīng)模板化），并且由各種子控件構(gòu)成。這些控件保留了一個(gè)構(gòu)成項(xiàng)（通常為表的行或單元格）的列表。該列表在經(jīng)過(guò)回發(fā)后會(huì)保存在視圖狀態(tài)中，并且從綁定數(shù)據(jù)生成或從視圖狀態(tài)重建。該控件還在視圖狀態(tài)中保存其構(gòu)成項(xiàng)的數(shù)量，以便在頁(yè)面中其他控件引起回發(fā)時(shí)可以正確重建表結(jié)構(gòu)。我將用 DataGrid 控件舉例說(shuō)明。

DataGrid 由一列行構(gòu)成，每一行都代表綁定數(shù)據(jù)源中的一個(gè)記錄。每個(gè)網(wǎng)格行都通過(guò)一個(gè) DataGridRow 對(duì)象（從 TableRow 派生的一個(gè)類）表示。在各網(wǎng)格行創(chuàng)建完成并被添加到最終網(wǎng)格表時(shí)，諸如 ItemCreated 和 ItemDataBound 之類的相應(yīng)事件將被引發(fā)至頁(yè)面。當(dāng)通過(guò)數(shù)據(jù)綁定創(chuàng)建 DataGrid 時(shí)，其行數(shù)由綁定項(xiàng)數(shù)和頁(yè)面大小決定。如果帶有 DataGrid 的頁(yè)面回發(fā)會(huì)怎樣？

這種情況下，如果是由 DataGrid 自身引起的回發(fā)（例如，用戶單擊以進(jìn)行排序或標(biāo)頁(yè)），則新頁(yè)面會(huì)再次通過(guò)數(shù)據(jù)綁定來(lái)呈現(xiàn) DataGrid。這是顯而易見(jiàn)的，因?yàn)?DataGrid 需要刷新數(shù)據(jù)進(jìn)行顯示。如果是主頁(yè)回發(fā)，則情況就不同了，因?yàn)閱螕袅隧?yè)面上的另一個(gè)控件（例如某按鈕）。這種情況下，DataGrid 不綁定到數(shù)據(jù)并且必須從視圖狀態(tài)進(jìn)行重建。（如果禁用了視圖狀態(tài)，就是另外一種情況了，這時(shí)只能通過(guò)數(shù)據(jù)綁定顯示網(wǎng)格。）

數(shù)據(jù)源不保存在視圖狀態(tài)中。作為復(fù)合控件，DataGrid 包含子控件，其中每個(gè)子控件都將自己的狀態(tài)保存到視圖狀態(tài)并從視圖狀態(tài)恢復(fù)。DataGrid 只需跟蹤在所有行和所包含控件從視圖狀態(tài)恢復(fù)之前它所必須重復(fù)執(zhí)行的次數(shù)。此次數(shù)與所顯示綁定項(xiàng)的數(shù)量一致，并且必須作為控件狀態(tài)的一部分存儲(chǔ)到視圖狀態(tài)中。在 ASP.NET 1.x 中，您必須自己學(xué)習(xí)并實(shí)現(xiàn)此模式。在 ASP.NET 2.0 中，從新類 CompositeDataBoundControl 派生您的復(fù)合控件就可以了。

讓我們嘗試使用一種顯示可擴(kuò)展數(shù)據(jù)綁定新聞標(biāo)題行的網(wǎng)格類控件。在此過(guò)程中，我們將再度使用在前文中論及的 Headline 控件。

public class HeadlineListEx :CompositeDataBoundControl  
{  
  :  
}  

HeadlineListEx 控件包含了一個(gè)收集了所有綁定數(shù)據(jù)項(xiàng)的 Items 集合屬性。該集合為公共集合，并且可在與多數(shù)列表控件一起運(yùn)行時(shí)通過(guò)編程方式填充。對(duì)典型數(shù)據(jù)綁定的支持是通過(guò)一對(duì)屬性（DataTextField 和 DataTitleField）實(shí)現(xiàn)的。這兩個(gè)屬性表明了數(shù)據(jù)源中將用于填充新聞標(biāo)題和文本的字段。Items 集合被保存到視圖狀態(tài)中。

要將 HeadlineListEx 控件轉(zhuǎn)換為真正的ASP.NET復(fù)合控件，您首先需要從 CompositeDataBoundControl 將其派生出來(lái)，然后再替換 CreateChildControls。有意思的是，你會(huì)注意到 CreateChildControls 是重載方法。

override int CreateChildControls()  
override int CreateChildControls(IEnumerable data, bool dataBinding)  

***個(gè)重載方法替換了在 Control 類中定義的方法。第二個(gè)重載方法是每個(gè)復(fù)合控件都必須替換的一種抽象方法。實(shí)際上，復(fù)合控件的開(kāi)發(fā)工作簡(jiǎn)化為兩大主要任務(wù)：

替換 CreateChildControls。

實(shí)現(xiàn) Rows 集合屬性以跟蹤控件的所有構(gòu)成項(xiàng)。

Rows 屬性不同于 Items，因?yàn)樗槐４嬖谝晥D狀態(tài)中，且具有與請(qǐng)求相同的生存期，并引用幫助程序?qū)ο蠖皇墙壎〝?shù)據(jù)項(xiàng)。

public virtual HeadlineRowCollection Rows  
{  
get 
    {  
if (_rows == null)  
_rows = new HeadlineRowCollection();  
return _rows;  
     }  
}  

Rows 集合在控件生成時(shí)填充。讓我們看一下 CreateChildControls 的替換方法。該方法采用了兩個(gè)參數(shù)：綁定項(xiàng)和一個(gè)布爾標(biāo)記，其中布爾標(biāo)記用于指明該控件是通過(guò)數(shù)據(jù)綁定創(chuàng)建還是通過(guò)視圖狀態(tài)創(chuàng)建。（請(qǐng)注意示例程序文件中的程序員注釋使用的是英文，本文中將其譯為中文是為了便于參考。）

override int CreateChildControls(IEnumerable dataSource, bool dataBinding)  
{  
if (dataBinding)  
   {  
string textField = DataTextField;  
string titleField = DataTitleField;  
if (dataSource != null)  
      {  
foreach (object o in dataSource)  
         {  
HeadlineItem elem = new HeadlineItem();  
elem.Text = DataBinder.GetPropertyValue(o, textField, null);  
elem.Title = DataBinder.GetPropertyValue(o, titleField, null);  
Items.Add(elem);  
         }  
      }  
   }   
 
// 開(kāi)始生成控件層次結(jié)構(gòu)  
Table t = new Table();  
Controls.Add(t);  
Rows.Clear();  
int itemCount = 0;  
 
foreach(HeadlineItem item in Items)  
   {  
HeadlineRowType type = HeadlineRowType.Simple;  
HeadlineRow row = CreateHeadlineRow(t, type,   
item, itemCount, dataBinding);  
_rows.Add(row);  
itemCount++;  
    }  
 
return itemCount;  
}  
 

在數(shù)據(jù)綁定的情況下，首先要填充 Items 集合。遍歷綁定集合，提取數(shù)據(jù)，然后填充 HeadlineItem 類的新建實(shí)例。接下來(lái)，遍歷 Items 集合（該集合中可能包含以編程方式添加的附加項(xiàng)），并在控件中創(chuàng)建行。

HeadlineRow CreateHeadlineRow(Table t, HeadlineRowType rowType,   
HeadlineItem dataItem, int index, bool dataBinding)  
{  
// 為最外部表創(chuàng)建新行  
HeadlineRow row = new HeadlineRow(rowType);  
 
// 為子控件創(chuàng)建單元格  
TableCell cell = new TableCell();  
row.Cells.Add(cell);  
Headline item = new Headline();  
cell.Controls.Add(item);  
 
// 此時(shí)引發(fā) HeadlineRowCreated 事件  
 
// 將此行添加到所創(chuàng)建的 HTML 表  
t.Rows.Add(row);  
 
// 處理數(shù)據(jù)對(duì)象綁定  
if (dataBinding)  
   {  
row.DataItem = dataItem;  
Headline ctl = (Headline) cell.Controls[0];  
ctl.Text = dataItem.Text;  
ctl.Title = dataItem.Title;  
                  
// 此時(shí)引發(fā) HeadlineRowDataBound 事件  
    }  
return row;  
}  
 

CreateHeadlineRow 方法會(huì)創(chuàng)建并返回 HeadlineRow 類（從 TableRow 派生而來(lái)）的一個(gè)實(shí)例。在這種情況下，此行會(huì)包含一個(gè)由 Headline 控件填充的單元格。在其他情況下，您可以更改此部分代碼以根據(jù)需要添加多個(gè)單元格并相應(yīng)填充內(nèi)容。

重要的是，要將所需完成的任務(wù)分為兩個(gè)不同的步驟：創(chuàng)建和數(shù)據(jù)綁定。首先，創(chuàng)建行的布局，引發(fā)行創(chuàng)建事件（如果有），并***將其添加到父表中。接下來(lái)，如果要將控件綁定到數(shù)據(jù)，則設(shè)置對(duì)綁定數(shù)據(jù)敏感的子控件屬性。完成操作后，則引發(fā)一個(gè)行數(shù)據(jù)綁定事件（如果有）。

請(qǐng)注意，該模式更準(zhǔn)確描述了ASP.NET復(fù)合控件的內(nèi)部體系結(jié)構(gòu)。

可以使用以下代碼來(lái)引發(fā)事件。

HeadlineRowEventArgs e = new HeadlineRowEventArgs();  
e.DataItem = dataItem;  
e.RowIndex = index;  
e.RowType = rowType;  
e.Item = row;  
OnHeadlineRowDataBound(e);  

請(qǐng)注意，只在要引發(fā)數(shù)據(jù)綁定事件時(shí)才設(shè)置 DataItem 屬性。事件數(shù)據(jù)結(jié)構(gòu)被任意設(shè)置為以下形式。如果您認(rèn)為有必要，盡可以對(duì)其進(jìn)行更改。

public class HeadlineRowEventArgs :EventArgs  
{  
public HeadlineItem DataItem;  
public HeadlineRowType RowType;  
public int RowIndex;  
public HeadlineRow Item;  
}  

若要實(shí)際引發(fā)一個(gè)事件，通常的做法是使用一個(gè)如下定義的受保護(hù)方法。

protected virtual void OnHeadlineRowDataBound(HeadlineRowEventArgs e)  
{  
if (HeadlineRowDataBound != null)  
HeadlineRowDataBound(this, e);  
}  

若要聲明此事件，可在 ASP.NET 2.0 中使用新的一般事件處理程序委托。

public event EventHandler< HeadlineRowEventArgs> HeadlineRowDataBound;  

在示例頁(yè)中，一切均照常執(zhí)行。您可在控件標(biāo)記上定義處理程序并將某方法寫入代碼文件。示例如下。

< cc1:HeadlineListEx runat="server" ID="HeadlineListEx1"   
DataTextField="notes" DataTitleField="lastname"   
DataSourceID="MySource" OnHeadlineRowDataBound="HeadlineRowCreated" /> 

HeadlineRowCreated 事件處理程序的代碼顯示如下。

protected void HeadlineRowCreated(object sender, HeadlineRowEventArgs e)  
{  
if (e.DataItem.Title.Contains("Doe"))  
e.Item.BackColor = Color.Red;  
}  
  

圖 7：運(yùn)行中的 HeadlineListEx 控件

通過(guò)掛接數(shù)據(jù)綁定事件，所有含有 Doe 的項(xiàng)都將以紅色背景呈現(xiàn)。

【編輯推薦】

1. ASP.NET復(fù)合控件與CompositeControl類
2. ASP.NET復(fù)合控件的呈現(xiàn)引擎
3. ASP.NET復(fù)合控件簡(jiǎn)介及要點(diǎn)一覽
4. ASP.NET控件開(kāi)發(fā)基礎(chǔ)之復(fù)合控件事件處理淺析
5. ASP.NET控件開(kāi)發(fā)基礎(chǔ)之復(fù)合控件淺析