DataSourceView クラス

定義

名前空間:

System.Web.UI

アセンブリ:

System.Web.dll

データ ソース コントロールの機能を定義するすべてのデータ ソース ビュー クラスの基本クラスとして機能します。

public ref class DataSourceView abstract

public abstract class DataSourceView

type DataSourceView = class

Public MustInherit Class DataSourceView

継承

Object

DataSourceView

派生

System.Web.UI.WebControls.EntityDataSourceView

System.Web.UI.WebControls.ModelDataSourceView

System.Web.UI.WebControls.ObjectDataSourceView

System.Web.UI.WebControls.QueryableDataSourceView

System.Web.UI.WebControls.SiteMapDataSourceView

System.Web.UI.WebControls.SqlDataSourceView

System.Web.UI.WebControls.XmlDataSourceView

例

次のコード例では、 クラスを DataSourceView 拡張して、データ ソース コントロールの厳密に型指定されたビュー クラスを作成する方法を示します。 クラスは CsVDataSourceView 、データ ソース コントロールの機能を CsvDataSource 定義し、データ バインド コントロールがコンマ区切り値 (.csv) ファイルに格納されているデータを使用するための実装を提供します。 データ ソース 管理の CsvDataSource 詳細については、 クラスを DataSourceControl 参照してください。

// 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();
    }
}

' 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

注釈

ASP.NET では、Web サーバー コントロールが一貫した方法でデータにバインドできるようにするデータ バインディング アーキテクチャがサポートされています。 データにバインドする Web サーバー コントロールはデータ バインド コントロールと呼ばれ、そのバインドを容易にするクラスはデータ ソース コントロールと呼ばれます。 データ ソース コントロールは、リレーショナル データベース、ファイル、ストリーム、ビジネス オブジェクトなどの任意のデータ ソースを表すことができます。 データ ソース コントロールは、基になるデータのソースまたは形式に関係なく、データ バインド コントロールに一貫した方法でデータを表示します。

ほとんどの Web 開発タスクを実行するには、ASP.NET (、、、 XmlDataSourceなどSqlDataSourceAccessDataSource) で提供されるデータ ソース 管理を使用します。 独自のカスタム データ ソース管理を実装する場合は、基本 DataSourceControl クラスと DataSourceView クラスを使用します。

データ ソース コントロールは、データ ソース ビューと呼ばれるオブジェクトとそれに関連付けられているデータ リストの組み合わせ IDataSource と考えることができます。 データの各リストは、 オブジェクトによって DataSourceView 表されます。 クラスは DataSourceView 、データ ソース コントロールに関連付けられているすべてのデータ ソース ビューまたはデータのリストの基本クラスです。 データ ソース ビューは、データ ソース 管理の機能を定義します。 基になるデータ ストレージには 1 つ以上のデータ リストが含まれているため、データ ソース 管理は常に 1 つ以上の名前付きデータ ソース ビューに関連付けられます。 データ ソース コントロールでは、 メソッドを GetViewNames 使用して、現在データ ソース コントロールに関連付けられているデータ ソース ビューを列挙し、 メソッドを GetView 使用して特定のデータ ソース ビュー インスタンスを名前で取得します。

すべての DataSourceView オブジェクトは、 メソッドを使用して基になるデータ ソースからのデータ取得を ExecuteSelect サポートします。 必要に応じて、すべてのビューで、 などの操作をExecuteInsertExecuteUpdate含む基本的な一連の操作がサポートされますExecuteDelete。 データ バインド コントロールは、 メソッドと GetViewNames メソッドを使用してGetView関連付けられたデータ ソース ビューを取得し、デザイン時または実行時にビューに対してクエリを実行することで、データ ソース コントロールの機能を検出できます。

コンストラクター

DataSourceView(IDataSource, String)

DataSourceView クラスの新しいインスタンスを初期化します。

プロパティ

CanDelete	現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで ExecuteDelete(IDictionary, IDictionary) 操作がサポートされているかどうかを示す値を取得します。
CanInsert	現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで ExecuteInsert(IDictionary) 操作がサポートされているかどうかを示す値を取得します。
CanPage	現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで、ExecuteSelect(DataSourceSelectArguments) メソッドで取得したデータを使用するページングがサポートされているかどうかを示す値を取得します。
CanRetrieveTotalRowCount	現在の DataSourceControl オブジェクトに関連付けられた DataSourceView オブジェクトで、データではなく行の合計数を取得する操作がサポートされているかどうかを示す値を取得します。
CanSort	現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで、基になるデータ ソースに対する並べ替え済みのビューがサポートされているかどうかを示す値を取得します。
CanUpdate	現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで ExecuteUpdate(IDictionary, IDictionary, IDictionary) 操作がサポートされているかどうかを示す値を取得します。
Events	データ ソース ビューのイベント ハンドラー デリゲートのリストを取得します。
Name	データ ソース ビュー名を取得します。

メソッド

CanExecute(String)	指定したコマンドを実行できるかどうかを判断します。
Delete(IDictionary, IDictionary, DataSourceViewOperationCallback)	DataSourceView オブジェクトで表されたデータのリストに対して、削除操作を非同期に実行します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)	指定されたコマンドを実行します。
ExecuteCommand(String, IDictionary, IDictionary)	指定されたコマンドを実行します。
ExecuteDelete(IDictionary, IDictionary)	DataSourceView オブジェクトで表されたデータのリストに対して、削除操作を実行します。
ExecuteInsert(IDictionary)	DataSourceView オブジェクトで表されたデータのリストに対して、挿入操作を実行します。
ExecuteSelect(DataSourceSelectArguments)	基になるデータ ストレージからデータのリストを取得します。
ExecuteUpdate(IDictionary, IDictionary, IDictionary)	DataSourceView オブジェクトで表されたデータのリストに対して、更新操作を実行します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Insert(IDictionary, DataSourceViewOperationCallback)	DataSourceView オブジェクトで表されたデータのリストに対して、挿入操作を非同期に実行します。
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
OnDataSourceViewChanged(EventArgs)	DataSourceViewChanged イベントを発生させます。
RaiseUnsupportedCapabilityError(DataSourceCapabilities)	RaiseUnsupportedCapabilitiesError(DataSourceView) メソッドによって呼び出され、ビューでサポートされている機能と ExecuteSelect(DataSourceSelectArguments) 操作に必要な機能を比較します。
Select(DataSourceSelectArguments, DataSourceViewSelectCallback)	基になるデータ ストレージからデータのリストを非同期に取得します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
Update(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback)	DataSourceView オブジェクトで表されたデータのリストに対して、更新操作を非同期に実行します。

イベント

DataSourceViewChanged

データ ソース ビューが変更された場合に発生します。

こちらもご覧ください

• DataSourceControl
• HierarchicalDataSourceView