DataBoundControl 類別
定義
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
作為所有 ASP.NET 2.0 版資料繫結控制項的基底類別，這些控制項會以清單或表格式表單顯示其資料。
public ref class DataBoundControl abstract : System::Web::UI::WebControls::BaseDataBoundControlpublic abstract class DataBoundControl : System.Web.UI.WebControls.BaseDataBoundControltype DataBoundControl = class
inherit BaseDataBoundControlPublic MustInherit Class DataBoundControl
Inherits BaseDataBoundControl- 繼承
- 衍生
範例
下列程式碼範例示範如何從 DataBoundControl 類別衍生類別，以建立自訂資料繫結控制項。 控制項 TextBoxSet 會 TextBox 針對從相關聯的資料來源控制項擷取的每個資料項目建立控制項，並在執行時間系結至資料項目的值。 方法的目前實作會將 Render 控制項轉 TextBox 譯為未排序的清單。
using System;
using System.Collections;
using System.ComponentModel;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
namespace Samples.AspNet.Controls.CS {
[AspNetHostingPermission(SecurityAction.Demand,
Level=AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level=AspNetHostingPermissionLevel.Minimal)]
public class TextBoxSet : DataBoundControl {
private IList alBoxSet;
public IList BoxSet {
get {
if (null == alBoxSet) {
alBoxSet = new ArrayList();
}
return alBoxSet;
}
}
public string DataTextField {
get {
object o = ViewState["DataTextField"];
return((o == null) ? string.Empty : (string)o);
}
set {
ViewState["DataTextField"] = value;
if (Initialized) {
OnDataPropertyChanged();
}
}
}
protected override void PerformSelect() {
// Call OnDataBinding here if bound to a data source using the
// DataSource property (instead of a DataSourceID), because the
// databinding statement is evaluated before the call to GetData.
if (! IsBoundUsingDataSourceID) {
OnDataBinding(EventArgs.Empty);
}
// The GetData method retrieves the DataSourceView object from
// the IDataSource associated with the data-bound control.
GetData().Select(CreateDataSourceSelectArguments(),
OnDataSourceViewSelectCallback);
// The PerformDataBinding method has completed.
RequiresDataBinding = false;
MarkAsDataBound();
// Raise the DataBound event.
OnDataBound(EventArgs.Empty);
}
private void OnDataSourceViewSelectCallback(IEnumerable retrievedData) {
// Call OnDataBinding only if it has not already been
// called in the PerformSelect method.
if (IsBoundUsingDataSourceID) {
OnDataBinding(EventArgs.Empty);
}
// The PerformDataBinding method binds the data in the
// retrievedData collection to elements of the data-bound control.
PerformDataBinding(retrievedData);
}
protected override void PerformDataBinding(IEnumerable retrievedData) {
base.PerformDataBinding(retrievedData);
// If the data is retrieved from an IDataSource as an
// IEnumerable collection, attempt to bind its values to a
// set of TextBox controls.
if (retrievedData != null) {
foreach (object dataItem in retrievedData) {
TextBox box = new TextBox();
// The dataItem is not just a string, but potentially
// a System.Data.DataRowView or some other container.
// If DataTextField is set, use it to determine which
// field to render. Otherwise, use the first field.
if (DataTextField.Length > 0) {
box.Text = DataBinder.GetPropertyValue(dataItem,
DataTextField, null);
}
else {
PropertyDescriptorCollection props =
TypeDescriptor.GetProperties(dataItem);
// Set the "default" value of the TextBox.
box.Text = String.Empty;
// Set the true data-bound value of the TextBox,
// if possible.
if (props.Count >= 1) {
if (null != props[0].GetValue(dataItem)) {
box.Text = props[0].GetValue(dataItem).ToString();
}
}
}
BoxSet.Add(box);
}
}
}
protected override void Render(HtmlTextWriter writer) {
// Render nothing if the control is empty.
if (BoxSet.Count <= 0) {
return;
}
// Make sure the control is declared in a form tag
// with runat=server.
if (Page != null) {
Page.VerifyRenderingInServerForm(this);
}
// For this example, render the BoxSet as
// an unordered list of TextBox controls.
writer.RenderBeginTag(HtmlTextWriterTag.Ul);
foreach (object item in BoxSet) {
TextBox box = (TextBox) item;
// Write each element as
// <li><input type="text" value="string"><input/></li>
writer.WriteBeginTag("li");
writer.Write(">");
writer.WriteBeginTag("input");
writer.WriteAttribute("type", "text");
writer.WriteAttribute("value", box.Text);
writer.Write(">");
writer.WriteEndTag("input");
writer.WriteEndTag("li");
}
writer.RenderEndTag();
}
}
}
Imports System.Collections
Imports System.ComponentModel
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Namespace Samples.AspNet.Controls.VB
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal), _
AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class TextBoxSet
Inherits DataBoundControl
Private alBoxSet As IList
Public ReadOnly Property BoxSet() As IList
Get
If alBoxSet Is Nothing Then
alBoxSet = New ArrayList()
End If
Return alBoxSet
End Get
End Property
Public Property DataTextField() As String
Get
Dim o As Object = ViewState("DataTextField")
If o Is Nothing Then
Return String.Empty
Else
Return CStr(o)
End If
End Get
Set(ByVal value As String)
ViewState("DataTextField") = value
If (Initialized) Then
OnDataPropertyChanged()
End If
End Set
End Property
Protected Overrides Sub PerformSelect()
' Call OnDataBinding here if bound to a data source using the
' DataSource property (instead of a DataSourceID) because the
' data-binding statement is evaluated before the call to GetData.
If Not IsBoundUsingDataSourceID Then
OnDataBinding(EventArgs.Empty)
End If
' The GetData method retrieves the DataSourceView object from the
' IDataSource associated with the data-bound control.
GetData().Select(CreateDataSourceSelectArguments(), _
AddressOf OnDataSourceViewSelectCallback)
' The PerformDataBinding method has completed.
RequiresDataBinding = False
MarkAsDataBound()
' Raise the DataBound event.
OnDataBound(EventArgs.Empty)
End Sub
Private Sub OnDataSourceViewSelectCallback(ByVal retrievedData As IEnumerable)
' Call OnDataBinding only if it has not already
' been called in the PerformSelect method.
If IsBoundUsingDataSourceID Then
OnDataBinding(EventArgs.Empty)
End If
' The PerformDataBinding method binds the data in the retrievedData
' collection to elements of the data-bound control.
PerformDataBinding(retrievedData)
End Sub
Protected Overrides Sub PerformDataBinding(ByVal retrievedData As IEnumerable)
MyBase.PerformDataBinding(retrievedData)
' If the data is retrieved from an IDataSource as an IEnumerable
' collection, attempt to bind its values to a set of TextBox controls.
If Not (retrievedData Is Nothing) Then
Dim dataItem As Object
For Each dataItem In retrievedData
Dim box As New TextBox()
' The dataItem is not just a string, but potentially
' a System.Data.DataRowView or some other container.
' If DataTextField is set, use it to determine which
' field to render. Otherwise, use the first field.
If DataTextField.Length > 0 Then
box.Text = DataBinder.GetPropertyValue( _
dataItem, DataTextField, Nothing)
Else
Dim props As PropertyDescriptorCollection = _
TypeDescriptor.GetProperties(dataItem)
' Set the "default" value of the TextBox.
box.Text = String.Empty
' Set the true data-bound value of the TextBox,
' if possible.
If props.Count >= 1 Then
If props(0).GetValue(dataItem) IsNot Nothing Then
box.Text = props(0).GetValue(dataItem).ToString()
End If
End If
End If
BoxSet.Add(box)
Next dataItem
End If
End Sub
Protected Overrides Sub Render(ByVal writer As HtmlTextWriter)
' Render nothing if the control is empty.
If BoxSet.Count <= 0 Then
Return
End If
' Make sure the control is declared in a form tag with runat=server.
If Not (Page Is Nothing) Then
Page.VerifyRenderingInServerForm(Me)
End If
' For this example, render the BoxSet as
' an unordered list of TextBox controls.
writer.RenderBeginTag(HtmlTextWriterTag.Ul)
Dim item As Object
For Each item In BoxSet
Dim box As TextBox = CType(item, TextBox)
' Write each element as
' <li><input type="text" value="string"><input/></li>
writer.WriteBeginTag("li")
writer.Write(">")
writer.WriteBeginTag("input")
writer.WriteAttribute("type", "text")
writer.WriteAttribute("value", box.Text)
writer.Write(">")
writer.WriteEndTag("input")
writer.WriteEndTag("li")
Next item
writer.RenderEndTag()
End Sub
End Class
End Namespace
下列程式碼範例示範如何使用 TextBoxSet 上一個範例中定義的 控制項，並將它系結至 AccessDataSource 控制項。
<%@Page language="c#" %>
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.Controls.CS"
Assembly="Samples.AspNet.Controls.CS" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>TextBoxSet Data-Bound Control - C# Example</title>
</head>
<body>
<form id="Form1" method="post" runat="server">
<aspSample:textboxset
id="TextBoxSet1"
runat="server"
datasourceid="AccessDataSource1" />
<asp:accessdatasource
id="AccessDataSource1"
runat="server"
datafile="Northwind.mdb"
selectcommand="SELECT lastname FROM Employees" />
</form>
</body>
</html>
<%@Page language="VB" %>
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.Controls.VB"
Assembly="Samples.AspNet.Controls.VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>TextBoxSet Data-Bound Control - VB Example</title>
</head>
<body>
<form id="Form1" method="post" runat="server">
<aspSample:textboxset
id="TextBoxSet1"
runat="server"
datasourceid="AccessDataSource1" />
<asp:accessdatasource
id="AccessDataSource1"
runat="server"
datafile="Northwind.mdb"
selectcommand="SELECT lastname FROM Employees" />
</form>
</body>
</html>
備註
類別 DataBoundControl 是用於 ASP.NET 控制項的基類，可從 ASP.NET 資料來源控制項擷取表格式或清單樣式資料，並將使用者介面 (UI) 元素系結至該資料以供顯示。 複合資料繫結控制項，例如 、 和 ;清單樣式的資料繫結控制項，例如 BulletedList 和 CheckBoxList ，以及衍生自 DataBoundControl 等其他控制項 AdRotator 。 FormViewDetailsViewGridView
頁面開發人員不會直接使用 DataBoundControl 類別;而是使用衍生自這個類別的控制項。
控制項開發人員擴充此類別，以建立資料繫結控制項，以使用 IDataSource 實作衍生自 和 DataSourceView 類別的 DataSourceControl 介面和類別的類別。 從 DataBoundControl 類別衍生類別時，請覆寫 PerformDataBinding 方法，將 控制項的 UI 元素系結至 方法所擷 GetData 取的資料。 在大部分情況下， PerformDataBinding 方法是您將在衍生類別中覆寫的唯一方法。
對於 ASP.NET 2.0 資料系結控制項， PerformSelect 此方法相當於 DataBind 方法，而且會在執行時間呼叫 以系結資料。 方法會 PerformSelect 呼叫 GetData 和 PerformDataBinding 方法。
建構函式
| DataBoundControl() |
初始化 DataBoundControl 類別，以供繼承的類別執行個體使用。 這個建構函式只能由繼承的類別呼叫。 |
屬性
| AccessKey |
取得或設定便捷鍵 (Access Key)，可讓您快速巡覽至 Web 伺服器控制項。 (繼承來源 WebControl) |
| Adapter |
針對控制項取得瀏覽器的特定配置器。 (繼承來源 Control) |
| AppRelativeTemplateSourceDirectory |
取得或設定包含了此控制項之 Page 或 UserControl 物件的相對應用程式虛擬目錄。 (繼承來源 Control) |
| Attributes |
取得任意屬性 (Attribute) 的集合 (只供呈現)，不與控制項上的屬性 (Property) 對應。 (繼承來源 WebControl) |
| BackColor |
取得或設定 Web 伺服器控制項的背景色彩。 (繼承來源 WebControl) |
| BindingContainer |
取得包含了此控制項之資料繫結的控制項。 (繼承來源 Control) |
| BorderColor |
取得或設定 Web 控制項的框線色彩。 (繼承來源 WebControl) |
| BorderStyle |
取得或設定 Web 伺服器控制項的框線樣式。 (繼承來源 WebControl) |
| BorderWidth |
取得或設定 Web 伺服器控制項的框線寬度。 (繼承來源 WebControl) |
| ChildControlsCreated |
取得值，指出是否已經建立伺服器控制項的子控制項。 (繼承來源 Control) |
| ClientID |
取得 ASP.NET 所產生之 HTML 標記的控制項識別碼。 (繼承來源 Control) |
| ClientIDMode |
取得或設定用來產生 ClientID 屬性值的演算法。 (繼承來源 Control) |
| ClientIDSeparator |
取得字元值，表示在 ClientID 屬性中所使用的分隔字元。 (繼承來源 Control) |
| Context |
取得與目前 Web 要求的伺服器控制項關聯的 HttpContext 物件。 (繼承來源 Control) |
| Controls |
取得 ControlCollection 物件，表示 UI 階層架構中指定之伺服器控制項的子控制項。 (繼承來源 Control) |
| ControlStyle |
取得 Web 伺服器控制項的樣式。 這個屬性主要由控制項開發人員使用。 (繼承來源 WebControl) |
| ControlStyleCreated |
取得值，指出 Style 物件是否已經為 ControlStyle 屬性建立。 這個屬性主要由控制項開發人員使用。 (繼承來源 WebControl) |
| CssClass |
取得或設定用戶端上 Web 伺服器控制項所呈現的階層式樣式表 (CSS)。 (繼承來源 WebControl) |
| DataItemContainer |
如果命名容器實作 IDataItemContainer，則取得命名容器的參考。 (繼承來源 Control) |
| DataKeysContainer |
如果命名容器實作 IDataKeysControl，則取得命名容器的參考。 (繼承來源 Control) |
| DataMember |
取得或設定資料繫結控制項繫結至的資料清單名稱 (如果資料來源包含多個不同資料項目清單)。 |
| DataSource |
取得或設定資料繫結控制項從中擷取其資料項目清單的物件。 (繼承來源 BaseDataBoundControl) |
| DataSourceID |
取得或設定控制項的識別碼，資料繫結控制項會由此擷取其項目清單。 |
| DataSourceObject |
取得物件，這個物件會實作可提供物件資料內容之存取權的 IDataSource 介面。 |
| DesignMode |
取得值，指出控制項是否正用於設計介面上。 (繼承來源 Control) |
| Enabled |
取得或設定值，指出 Web 伺服器控制項是否啟用。 (繼承來源 WebControl) |
| EnableTheming |
取得或設定值，指出佈景主題是否套用至此控制項。 (繼承來源 WebControl) |
| EnableViewState |
取得或設定值，該值表示伺服器控制項是否對要求的用戶端而言保持其檢視狀態，以及它包含的任何子控制項狀態。 (繼承來源 Control) |
| Events |
取得控制項事件處理常式委派 (Delegate) 的清單。 這個屬性是唯讀的。 (繼承來源 Control) |
| Font |
取得與 Web 伺服器控制項關聯的字型屬性。 (繼承來源 WebControl) |
| ForeColor |
取得或設定 Web 伺服器控制項的前景色彩 (通常是文字的色彩)。 (繼承來源 WebControl) |
| HasAttributes |
取得值，指出控制項是否已經設定屬性。 (繼承來源 WebControl) |
| HasChildViewState |
取得值，指出目前伺服器控制項的子控制項是否有任何已儲存的檢視狀態設定。 (繼承來源 Control) |
| Height |
取得或設定 Web 伺服器控制項的高度。 (繼承來源 WebControl) |
| ID |
取得或設定指派給伺服器控制項的程式設計識別項。 (繼承來源 Control) |
| IdSeparator |
取得用來分隔控制項識別項的字元。 (繼承來源 Control) |
| Initialized |
取得值，指出是否已初始化資料繫結控制項。 (繼承來源 BaseDataBoundControl) |
| IsBoundUsingDataSourceID |
取得值，指出是否已設定 DataSourceID 屬性。 (繼承來源 BaseDataBoundControl) |
| IsChildControlStateCleared |
取得值，指出這個控制項中所包含的控制項是否有控制項狀態。 (繼承來源 Control) |
| IsDataBindingAutomatic |
取得值，指出資料繫結是否為自動。 (繼承來源 BaseDataBoundControl) |
| IsEnabled |
取得值，指出是否啟用控制項。 (繼承來源 WebControl) |
| IsTrackingViewState |
取得值，指出伺服器控制項是否正在儲存檢視狀態的變更。 (繼承來源 Control) |
| IsUsingModelBinders |
取得值，指出模型繫結是否正在使用。 |
| IsUsingModelBinders |
在衍生類別中實作時，取得值，此值指出控制項是否正使用模型繫結器。 (繼承來源 BaseDataBoundControl) |
| IsViewStateEnabled |
取得值，指出這個控制項是否已啟用檢視狀態。 (繼承來源 Control) |
| ItemType |
取得或設定強型別資料繫結的資料項目型別名稱。 |
| LoadViewStateByID |
取得值，指出控制項是否依 ID (而不是索引) 參與載入其檢視狀態。 (繼承來源 Control) |
| NamingContainer |
取得伺服器控制項命名容器的參考，其建立唯一命名空間，在具有相同 ID 屬性值的伺服器控制項之間作區別。 (繼承來源 Control) |
| Page |
取得含有伺服器控制項的 Page 執行個體的參考。 (繼承來源 Control) |
| Parent |
在網頁控制階層架構中取得伺服器控制項之父控制項的參考。 (繼承來源 Control) |
| RenderingCompatibility |
取得值，這個值會指定將與呈現 HTML 相容的 ASP.NET 版本。 (繼承來源 Control) |
| RequiresDataBinding |
取得或設定值，指出是否應該呼叫 DataBind() 方法。 (繼承來源 BaseDataBoundControl) |
| SelectArguments |
取得 DataSourceSelectArguments 物件，當從資料來源控制項擷取資料時資料繫結控制項會使用它。 |
| SelectMethod |
為了讀取資料要呼叫的方法的名稱。 |
| Site |
當呈現在設計介面上時，取得裝載目前控制項之容器的資訊。 (繼承來源 Control) |
| SkinID |
取得或設定要套用至控制項的面板。 (繼承來源 WebControl) |
| Style |
取得文字屬性的集合，將呈現為 Web 伺服器控制項的外部標記上的樣式屬性。 (繼承來源 WebControl) |
| SupportsDisabledAttribute |
取得值，這個值表示當控制項的 |
| TabIndex |
取得或設定 Web 伺服器控制項的定位索引。 (繼承來源 WebControl) |
| TagKey |
取得對應至這個 Web 伺服器控制項的 HtmlTextWriterTag 值。 這個屬性主要由控制項開發人員使用。 (繼承來源 WebControl) |
| TagName |
取得控制項標記的名稱。 這個屬性主要由控制項開發人員使用。 (繼承來源 WebControl) |
| TemplateControl |
取得或設定包含了此控制項之樣板的參考。 (繼承來源 Control) |
| TemplateSourceDirectory |
取得包含目前伺服器控制項的 Page 或 UserControl 的虛擬目錄。 (繼承來源 Control) |
| ToolTip |
取得或設定當滑鼠指標停留在 Web 伺服器控制項時顯示的文字。 (繼承來源 WebControl) |
| UniqueID |
取得伺服器控制項唯一的、符合階層架構的識別項。 (繼承來源 Control) |
| ValidateRequestMode |
取得或設定值，指出控制項是否對來自瀏覽器的用戶端輸入檢查潛在的危險值。 (繼承來源 Control) |
| ViewState |
取得狀態資訊的字典，允許您在相同網頁的多個要求之間，儲存和還原伺服器控制項的檢視狀態。 (繼承來源 Control) |
| ViewStateIgnoresCase |
取得值，指出 StateBag 物件是否不區分大小寫。 (繼承來源 Control) |
| ViewStateMode |
取得或設定這個控制項的檢視狀態模式。 (繼承來源 Control) |
| Visible |
取得或設定值，指出伺服器控制項是否會轉譯為頁面上的 UI。 (繼承來源 Control) |
| Width |
取得或設定 Web 伺服器控制項的寬度。 (繼承來源 WebControl) |
方法
事件
| CallingDataMethods |
正在呼叫資料方法時發生。 |
| CreatingModelDataSource |
正在建立 ModelDataSource 物件時發生。 |
| DataBinding |
發生於伺服器控制項繫結至資料來源時。 (繼承來源 Control) |
| DataBound |
在伺服器控制項繫結至資料來源之後發生。 (繼承來源 BaseDataBoundControl) |
| Disposed |
發生於伺服器控制項從記憶體釋放時，這是在要求 ASP.NET 網頁時，伺服器控制項生命週期的最後階段。 (繼承來源 Control) |
| Init |
發生於初始化伺服器控制項時，是其生命週期中的第一個步驟。 (繼承來源 Control) |
| Load |
發生於載入伺服器控制項至 Page 物件時。 (繼承來源 Control) |
| PreRender |
在 Control 物件載入之後但在呈現之前發生。 (繼承來源 Control) |
| Unload |
發生於伺服器控制項從記憶體卸載時。 (繼承來源 Control) |
明確介面實作
擴充方法
| EnablePersistedSelection(BaseDataBoundControl) |
已淘汰.
啟用要保存於資料控制項中且支援選取和分頁的選項。 |
| FindDataSourceControl(Control) |
傳回與指定之控制項的資料控制項相關聯的資料來源。 |
| FindFieldTemplate(Control, String) |
傳回在指定之控制項的命名容器中所指定資料行的欄位樣板。 |
| FindMetaTable(Control) |
傳回包含資料控制項的中繼資料表物件。 |
