DataSourceControl 類別
定義
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
作為控制項的基底類別，這些控制項代表與資料繫結控制項的資料來源。
public ref class DataSourceControl abstract : System::Web::UI::Control, System::ComponentModel::IListSource, System::Web::UI::IDataSource[System.ComponentModel.Bindable(false)]
public abstract class DataSourceControl : System.Web.UI.Control, System.ComponentModel.IListSource, System.Web.UI.IDataSource[<System.ComponentModel.Bindable(false)>]
type DataSourceControl = class
inherit Control
interface IDataSource
interface IListSourcePublic MustInherit Class DataSourceControl
Inherits Control
Implements IDataSource, IListSource- 繼承
- 衍生
- 屬性
- 實作
範例
下列程式代碼範例示範類別如何擴充 DataSourceControl 類別。 控件 CsvDataSource 代表儲存在 .csv 檔案中的逗號分隔檔案數據。 類別CsvDataSource會提供自己的、 GetViewNames和其他方法實GetView作，因為基類實作無法運作。
using System;
using System.Collections;
using System.Data;
using System.IO;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
// The CsvDataSource is a data source control that retrieves its
// data from a comma-separated value file.
[AspNetHostingPermission(SecurityAction.Demand, Level=AspNetHostingPermissionLevel.Minimal)]
public class CsvDataSource : DataSourceControl
{
public CsvDataSource() : base() {}
// The comma-separated value file to retrieve data from.
public string FileName {
get {
return ((CsvDataSourceView)this.GetView(String.Empty)).SourceFile;
}
set {
// Only set if it is different.
if ( ((CsvDataSourceView)this.GetView(String.Empty)).SourceFile != value) {
((CsvDataSourceView)this.GetView(String.Empty)).SourceFile = value;
RaiseDataSourceChangedEvent(EventArgs.Empty);
}
}
}
// Do not add the column names as a data row. Infer columns if the CSV file does
// not include column names.
public bool IncludesColumnNames {
get {
return ((CsvDataSourceView)this.GetView(String.Empty)).IncludesColumnNames;
}
set {
// Only set if it is different.
if ( ((CsvDataSourceView)this.GetView(String.Empty)).IncludesColumnNames != value) {
((CsvDataSourceView)this.GetView(String.Empty)).IncludesColumnNames = value;
RaiseDataSourceChangedEvent(EventArgs.Empty);
}
}
}
// Return a strongly typed view for the current data source control.
private CsvDataSourceView view = null;
protected override DataSourceView GetView(string viewName) {
if (null == view) {
view = new CsvDataSourceView(this, String.Empty);
}
return view;
}
// The ListSourceHelper class calls GetList, which
// calls the DataSourceControl.GetViewNames method.
// Override the original implementation to return
// a collection of one element, the default view name.
protected override ICollection GetViewNames() {
ArrayList al = new ArrayList(1);
al.Add(CsvDataSourceView.DefaultViewName);
return al as ICollection;
}
}
// The CsvDataSourceView class encapsulates the
// capabilities of the CsvDataSource data source control.
public class CsvDataSourceView : DataSourceView
{
public CsvDataSourceView(IDataSource owner, string name) :base(owner, DefaultViewName) {
}
// The data source view is named. However, the CsvDataSource
// only supports one view, so the name is ignored, and the
// default name used instead.
public static string DefaultViewName = "CommaSeparatedView";
// The location of the .csv file.
private string sourceFile = String.Empty;
internal string SourceFile {
get {
return sourceFile;
}
set {
// Use MapPath when the SourceFile is set, so that files local to the
// current directory can be easily used.
string mappedFileName = HttpContext.Current.Server.MapPath(value);
sourceFile = mappedFileName;
}
}
// Do not add the column names as a data row. Infer columns if the CSV file does
// not include column names.
private bool columns = false;
internal bool IncludesColumnNames {
get {
return columns;
}
set {
columns = value;
}
}
// Get data from the underlying data source.
// Build and return a DataView, regardless of mode.
protected override IEnumerable ExecuteSelect(DataSourceSelectArguments selectArgs) {
IEnumerable dataList = null;
// Open the .csv file.
if (File.Exists(this.SourceFile)) {
DataTable data = new DataTable();
// Open the file to read from.
using (StreamReader sr = File.OpenText(this.SourceFile)) {
// Parse the line
string s = "";
string[] dataValues;
DataColumn col;
// Do the following to add schema.
dataValues = sr.ReadLine().Split(',');
// For each token in the comma-delimited string, add a column
// to the DataTable schema.
foreach (string token in dataValues) {
col = new DataColumn(token,typeof(string));
data.Columns.Add(col);
}
// Do not add the first row as data if the CSV file includes column names.
if (! IncludesColumnNames)
data.Rows.Add(CopyRowData(dataValues, data.NewRow()));
// Do the following to add data.
while ((s = sr.ReadLine()) != null) {
dataValues = s.Split(',');
data.Rows.Add(CopyRowData(dataValues, data.NewRow()));
}
}
data.AcceptChanges();
DataView dataView = new DataView(data);
if (!string.IsNullOrEmpty(selectArgs.SortExpression)) {
dataView.Sort = selectArgs.SortExpression;
}
dataList = dataView;
}
else {
throw new System.Configuration.ConfigurationErrorsException("File not found, " + this.SourceFile);
}
if (null == dataList) {
throw new InvalidOperationException("No data loaded from data source.");
}
return dataList;
}
private DataRow CopyRowData(string[] source, DataRow target) {
try {
for (int i = 0;i < source.Length;i++) {
target[i] = source[i];
}
}
catch (System.IndexOutOfRangeException) {
// There are more columns in this row than
// the original schema allows. Stop copying
// and return the DataRow.
return target;
}
return target;
}
// The CsvDataSourceView does not currently
// permit deletion. You can modify or extend
// this sample to do so.
public override bool CanDelete {
get {
return false;
}
}
protected override int ExecuteDelete(IDictionary keys, IDictionary values)
{
throw new NotSupportedException();
}
// The CsvDataSourceView does not currently
// permit insertion of a new record. You can
// modify or extend this sample to do so.
public override bool CanInsert {
get {
return false;
}
}
protected override int ExecuteInsert(IDictionary values)
{
throw new NotSupportedException();
}
// The CsvDataSourceView does not currently
// permit update operations. You can modify or
// extend this sample to do so.
public override bool CanUpdate {
get {
return false;
}
}
protected override int ExecuteUpdate(IDictionary keys, IDictionary values, IDictionary oldValues)
{
throw new NotSupportedException();
}
}
Imports System.Collections
Imports System.Data
Imports System.IO
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Namespace Samples.AspNet.VB.Controls
' The CsvDataSource is a data source control that retrieves its
' data from a comma-separated value file.
<AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class CsvDataSource
Inherits DataSourceControl
Public Sub New()
End Sub
' The comma-separated value file to retrieve data from.
Public Property FileName() As String
Get
Return CType(Me.GetView([String].Empty), CsvDataSourceView).SourceFile
End Get
Set
' Only set if it is different.
If CType(Me.GetView([String].Empty), CsvDataSourceView).SourceFile <> value Then
CType(Me.GetView([String].Empty), CsvDataSourceView).SourceFile = value
RaiseDataSourceChangedEvent(EventArgs.Empty)
End If
End Set
End Property
' Do not add the column names as a data row. Infer columns if the CSV file does
' not include column names.
Public Property IncludesColumnNames() As Boolean
Get
Return CType(Me.GetView([String].Empty), CsvDataSourceView).IncludesColumnNames
End Get
Set
' Only set if it is different.
If CType(Me.GetView([String].Empty), CsvDataSourceView).IncludesColumnNames <> value Then
CType(Me.GetView([String].Empty), CsvDataSourceView).IncludesColumnNames = value
RaiseDataSourceChangedEvent(EventArgs.Empty)
End If
End Set
End Property
' Return a strongly typed view for the current data source control.
Private view As CsvDataSourceView = Nothing
Protected Overrides Function GetView(viewName As String) As DataSourceView
If view Is Nothing Then
view = New CsvDataSourceView(Me, String.Empty)
End If
Return view
End Function 'GetView
' The ListSourceHelper class calls GetList, which
' calls the DataSourceControl.GetViewNames method.
' Override the original implementation to return
' a collection of one element, the default view name.
Protected Overrides Function GetViewNames() As ICollection
Dim al As New ArrayList(1)
al.Add(CsvDataSourceView.DefaultViewName)
Return CType(al, ICollection)
End Function 'GetViewNames
End Class
' The CsvDataSourceView class encapsulates the
' capabilities of the CsvDataSource data source control.
Public Class CsvDataSourceView
Inherits DataSourceView
Public Sub New(owner As IDataSource, name As String)
MyBase.New(owner, DefaultViewName)
End Sub
' The data source view is named. However, the CsvDataSource
' only supports one view, so the name is ignored, and the
' default name used instead.
Public Shared DefaultViewName As String = "CommaSeparatedView"
' The location of the .csv file.
Private aSourceFile As String = [String].Empty
Friend Property SourceFile() As String
Get
Return aSourceFile
End Get
Set
' Use MapPath when the SourceFile is set, so that files local to the
' current directory can be easily used.
Dim mappedFileName As String
mappedFileName = HttpContext.Current.Server.MapPath(value)
aSourceFile = mappedFileName
End Set
End Property
' Do not add the column names as a data row. Infer columns if the CSV file does
' not include column names.
Private columns As Boolean = False
Friend Property IncludesColumnNames() As Boolean
Get
Return columns
End Get
Set
columns = value
End Set
End Property
' Get data from the underlying data source.
' Build and return a DataView, regardless of mode.
Protected Overrides Function ExecuteSelect(selectArgs As DataSourceSelectArguments) _
As System.Collections.IEnumerable
Dim dataList As IEnumerable = Nothing
' Open the .csv file.
If File.Exists(Me.SourceFile) Then
Dim data As New DataTable()
' Open the file to read from.
Dim sr As StreamReader = File.OpenText(Me.SourceFile)
Try
' Parse the line
Dim dataValues() As String
Dim col As DataColumn
' Do the following to add schema.
dataValues = sr.ReadLine().Split(","c)
' For each token in the comma-delimited string, add a column
' to the DataTable schema.
Dim token As String
For Each token In dataValues
col = New DataColumn(token, System.Type.GetType("System.String"))
data.Columns.Add(col)
Next token
' Do not add the first row as data if the CSV file includes column names.
If Not IncludesColumnNames Then
data.Rows.Add(CopyRowData(dataValues, data.NewRow()))
End If
' Do the following to add data.
Dim s As String
Do
s = sr.ReadLine()
If Not s Is Nothing Then
dataValues = s.Split(","c)
data.Rows.Add(CopyRowData(dataValues, data.NewRow()))
End If
Loop Until s Is Nothing
Finally
sr.Close()
End Try
data.AcceptChanges()
Dim dataView As New DataView(data)
If Not selectArgs.SortExpression Is String.Empty Then
dataView.Sort = selectArgs.SortExpression
End If
dataList = dataView
Else
Throw New System.Configuration.ConfigurationErrorsException("File not found, " + Me.SourceFile)
End If
If dataList is Nothing Then
Throw New InvalidOperationException("No data loaded from data source.")
End If
Return dataList
End Function 'ExecuteSelect
Private Function CopyRowData([source]() As String, target As DataRow) As DataRow
Try
Dim i As Integer
For i = 0 To [source].Length - 1
target(i) = [source](i)
Next i
Catch iore As IndexOutOfRangeException
' There are more columns in this row than
' the original schema allows. Stop copying
' and return the DataRow.
Return target
End Try
Return target
End Function 'CopyRowData
' The CsvDataSourceView does not currently
' permit deletion. You can modify or extend
' this sample to do so.
Public Overrides ReadOnly Property CanDelete() As Boolean
Get
Return False
End Get
End Property
Protected Overrides Function ExecuteDelete(keys As IDictionary, values As IDictionary) As Integer
Throw New NotSupportedException()
End Function 'ExecuteDelete
' The CsvDataSourceView does not currently
' permit insertion of a new record. You can
' modify or extend this sample to do so.
Public Overrides ReadOnly Property CanInsert() As Boolean
Get
Return False
End Get
End Property
Protected Overrides Function ExecuteInsert(values As IDictionary) As Integer
Throw New NotSupportedException()
End Function 'ExecuteInsert
' The CsvDataSourceView does not currently
' permit update operations. You can modify or
' extend this sample to do so.
Public Overrides ReadOnly Property CanUpdate() As Boolean
Get
Return False
End Get
End Property
Protected Overrides Function ExecuteUpdate(keys As IDictionary, _
values As IDictionary, _
oldValues As IDictionary) As Integer
Throw New NotSupportedException()
End Function 'ExecuteUpdate
End Class
End Namespace
下列程式代碼範例示範如何在 Web 表單中使用 CsvDataSource 控制件。
<%@ Page Language="C#" %>
<%@ Register Tagprefix="aspSample"
Namespace="Samples.AspNet.CS.Controls" %>
<!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 runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<asp:gridview
id="GridView1"
runat="server"
allowsorting="True"
datasourceid="CsvDataSource1" />
<aspSample:CsvDataSource
id = "CsvDataSource1"
runat = "server"
filename = "sample.csv"
includescolumnnames="True" />
</form>
</body>
</html>
<%@ Page Language="VB" %>
<%@ Register Tagprefix="aspSample"
Namespace="Samples.AspNet.VB.Controls" %>
<!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 runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
<asp:gridview
id="GridView1"
runat="server"
allowsorting="True"
datasourceid="CsvDataSource1" />
<aspSample:CsvDataSource
id = "CsvDataSource1"
runat = "server"
filename = "sample.csv"
includescolumnnames="True" />
</form>
</body>
</html>
備註
ASP.NET 支援控件數據系結架構，可讓 Web 伺服器控制項以一致的方式系結至數據。 系結至數據的 Web 伺服器控制件稱為數據綁定控件，以及有助於系結的類別稱為數據源控件。 數據源控件可以代表任何數據源：關係資料庫、檔案、數據流、商務物件等等。 數據源控件會以一致的方式呈現數據給數據綁定控件，而不論基礎數據的來源或格式為何。
您可以使用提供給 ASP.NET 的數據源控件，包括 SqlDataSource、 AccessDataSource和 XmlDataSource，來執行大部分的 Web 開發工作。 當您想要實作自己的自定義數據源控件時，請使用基 DataSourceControl 類。
雖然任何實作 介面的 IDataSource 類別都是數據源控件，但大部分 ASP.NET 數據源控件都會擴充抽象 DataSourceControl 類，以提供介面的 IDataSource 基底實作。 類別 DataSourceControl 也提供 介面的 IListSource 實作，可讓您以程序設計方式將數據源控件指派給 DataSource 數據綁定控件的 屬性，並將數據傳回控件做為基本清單。
衍生自 DataBoundControl 類別的任何 ASP.NET 控件都可以系結至數據源控件。
DataBoundControl當 系結至數據源控件時，會在運行時間自動執行數據系結。 您也可以搭配使用資料來源控制項搭配 ASP.NET 控制件，這些控制件會公開 DataSource 或 DataSourceID 屬性並支援基本資料系結，但不是衍生自 DataBoundControl。 使用這些數據綁定控件時，您必須明確呼叫 DataBind 方法。 如需數據系結的詳細資訊，請參閱 ASP.NET 數據存取內容對應。
您可以將數據源控件視為物件及其相關聯數據清單的組合 DataSourceControl ，稱為數據源檢視。 每個數據清單都是以 DataSourceView 物件表示。 因為基礎數據記憶體包含一或多個數據清單，所以 一 DataSourceControl 律會與一或多個具名 DataSourceView 對象相關聯。 介面 IDataSource 會定義所有數據源控件用來與數據源檢視互動的方法： GetViewNames 方法是用來列舉目前與數據源控件相關聯的數據源檢視，而 GetView 方法則用來依名稱擷取特定的數據源檢視實例。
您也可以將數據源控件視為呼叫端用來存取數據的兩個不同的介面。 類別 DataSourceControl 是頁面開發人員在開發 Web Forms 頁面時直接與互動的介面，而 DataSourceView 類別則是數據綁定控件和數據綁定控件作者互動的介面。 DataSourceView因為物件只能在運行時間使用，所以數據源控件或數據源檢視所保存的任何狀態都必須由數據源控件直接公開。
沒有 ASP.NET 數據源控件的視覺轉譯;它們會實作為控件，讓您可以以宣告方式建立它們，並選擇性地允許它們參與狀態管理。 因此，數據源控件不支援 或 SkinID等EnableTheming視覺功能。
建構函式
| DataSourceControl() |
初始化 DataSourceControl 類別的新執行個體。 |
屬性
| Adapter |
針對控制項取得瀏覽器的特定配置器。 (繼承來源 Control) |
| AppRelativeTemplateSourceDirectory |
取得或設定包含了此控制項之 Page 或 UserControl 物件的相對應用程式虛擬目錄。 (繼承來源 Control) |
| BindingContainer |
取得包含了此控制項之資料繫結的控制項。 (繼承來源 Control) |
| ChildControlsCreated |
取得值，指出是否已經建立伺服器控制項的子控制項。 (繼承來源 Control) |
| ClientID |
取得 ASP.NET 產生的伺服器控制項識別項。 |
| ClientIDMode |
這個屬性不會用於資料來源控制項。 |
| ClientIDMode |
取得或設定用來產生 ClientID 屬性值的演算法。 (繼承來源 Control) |
| ClientIDSeparator |
取得字元值，表示在 ClientID 屬性中所使用的分隔字元。 (繼承來源 Control) |
| Context |
取得與目前 Web 要求的伺服器控制項關聯的 HttpContext 物件。 (繼承來源 Control) |
| Controls |
取得 ControlCollection 物件，表示 UI 階層架構中指定之伺服器控制項的子控制項。 |
| DataItemContainer |
如果命名容器實作 IDataItemContainer，則取得命名容器的參考。 (繼承來源 Control) |
| DataKeysContainer |
如果命名容器實作 IDataKeysControl，則取得命名容器的參考。 (繼承來源 Control) |
| DesignMode |
取得值，指出控制項是否正用於設計介面上。 (繼承來源 Control) |
| EnableTheming |
取得值，指出這個控制項是否支援佈景主題。 |
| EnableViewState |
取得或設定值，該值表示伺服器控制項是否對要求的用戶端而言保持其檢視狀態，以及它包含的任何子控制項狀態。 (繼承來源 Control) |
| Events |
取得控制項事件處理常式委派 (Delegate) 的清單。 這個屬性是唯讀的。 (繼承來源 Control) |
| HasChildViewState |
取得值，指出目前伺服器控制項的子控制項是否有任何已儲存的檢視狀態設定。 (繼承來源 Control) |
| ID |
取得或設定指派給伺服器控制項的程式設計識別項。 (繼承來源 Control) |
| IdSeparator |
取得用來分隔控制項識別項的字元。 (繼承來源 Control) |
| IsChildControlStateCleared |
取得值，指出這個控制項中所包含的控制項是否有控制項狀態。 (繼承來源 Control) |
| IsTrackingViewState |
取得值，指出伺服器控制項是否正在儲存檢視狀態的變更。 (繼承來源 Control) |
| IsViewStateEnabled |
取得值，指出這個控制項是否已啟用檢視狀態。 (繼承來源 Control) |
| LoadViewStateByID |
取得值，指出控制項是否依 ID (而不是索引) 參與載入其檢視狀態。 (繼承來源 Control) |
| NamingContainer |
取得伺服器控制項命名容器的參考，其建立唯一命名空間，在具有相同 ID 屬性值的伺服器控制項之間作區別。 (繼承來源 Control) |
| Page |
取得含有伺服器控制項的 Page 執行個體的參考。 (繼承來源 Control) |
| Parent |
在網頁控制階層架構中取得伺服器控制項之父控制項的參考。 (繼承來源 Control) |
| RenderingCompatibility |
取得值，這個值會指定將與呈現 HTML 相容的 ASP.NET 版本。 (繼承來源 Control) |
| Site |
當呈現在設計介面上時，取得裝載目前控制項之容器的資訊。 (繼承來源 Control) |
| SkinID |
取得套用至 DataSourceControl 控制項的面板。 |
| TemplateControl |
取得或設定包含了此控制項之樣板的參考。 (繼承來源 Control) |
| TemplateSourceDirectory |
取得包含目前伺服器控制項的 Page 或 UserControl 的虛擬目錄。 (繼承來源 Control) |
| UniqueID |
取得伺服器控制項唯一的、符合階層架構的識別項。 (繼承來源 Control) |
| ValidateRequestMode |
取得或設定值，指出控制項是否對來自瀏覽器的用戶端輸入檢查潛在的危險值。 (繼承來源 Control) |
| ViewState |
取得狀態資訊的字典，允許您在相同網頁的多個要求之間，儲存和還原伺服器控制項的檢視狀態。 (繼承來源 Control) |
| ViewStateIgnoresCase |
取得值，指出 StateBag 物件是否不區分大小寫。 (繼承來源 Control) |
| ViewStateMode |
取得或設定這個控制項的檢視狀態模式。 (繼承來源 Control) |
| Visible |
取得或設定值，指出是否視覺化顯示控制項。 |
方法
事件
| DataBinding |
發生於伺服器控制項繫結至資料來源時。 (繼承來源 Control) |
| Disposed |
發生於伺服器控制項從記憶體釋放時，這是在要求 ASP.NET 網頁時，伺服器控制項生命週期的最後階段。 (繼承來源 Control) |
| Init |
發生於初始化伺服器控制項時，是其生命週期中的第一個步驟。 (繼承來源 Control) |
| Load |
發生於載入伺服器控制項至 Page 物件時。 (繼承來源 Control) |
| PreRender |
在 Control 物件載入之後但在呈現之前發生。 (繼承來源 Control) |
| Unload |
發生於伺服器控制項從記憶體卸載時。 (繼承來源 Control) |
明確介面實作
擴充方法
| FindDataSourceControl(Control) |
傳回與指定之控制項的資料控制項相關聯的資料來源。 |
| FindFieldTemplate(Control, String) |
傳回在指定之控制項的命名容器中所指定資料行的欄位樣板。 |
| FindMetaTable(Control) |
傳回包含資料控制項的中繼資料表物件。 |
| GetDefaultValues(IDataSource) |
取得所指定資料來源的預設值集合。 |
| GetMetaTable(IDataSource) |
取得所指定資料來源物件中的資料表中繼資料。 |
| TryGetMetaTable(IDataSource, MetaTable) |
判斷資料表中繼資料是否可供使用。 |
