DataSourceView DataSourceView DataSourceView DataSourceView Class

定義

データ ソース コントロールの機能を定義するすべてのデータ ソース ビュー クラスの基本クラスとして機能します。Serves as the base class for all data source view classes, which define the capabilities of data source controls.

public ref class DataSourceView abstract
public abstract class DataSourceView
type DataSourceView = class
Public MustInherit Class DataSourceView
継承
DataSourceViewDataSourceViewDataSourceViewDataSourceView
派生

DataSourceViewクラスを拡張して、データソースコントロールの厳密に型指定されたビュークラスを作成する方法を次のコード例に示します。The following code example demonstrates how to extend the DataSourceView class to create a strongly typed view class for a data source control. クラスCsVDataSourceViewは、 CsvDataSourceデータソースコントロールの機能を定義し、コンマ区切り値 (.csv) ファイルに格納されているデータを使用するためのデータバインドコントロールの実装を提供します。The CsVDataSourceView class defines the capabilities of the CsvDataSource data source control and provides an implementation for data-bound controls to use data stored in comma-separated value (.csv) files. CsvDataSourceデータソースコントロールの詳細については、 DataSourceControlクラスを参照してください。For more information on the CsvDataSource data source control, see the DataSourceControl class.

// 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 'CsvDataSourceView

注釈

ASP.NET では、Web サーバーコントロールが一貫した方法でデータにバインドできるデータバインディングアーキテクチャがサポートされています。ASP.NET supports a data-binding architecture that enables Web server controls to bind to data in a consistent fashion. データにバインドする Web サーバーコントロールはデータバインドコントロールと呼ばれ、そのバインドを容易にするクラスはデータソースコントロールと呼ばれます。Web server controls that bind to data are referred to as data-bound controls, and the classes that facilitate that binding are called data source controls. データソースコントロールは、リレーショナルデータベース、ファイル、ストリーム、ビジネスオブジェクトなど、任意のデータソースを表すことができます。Data source controls can represent any data source: a relational database, a file, a stream, a business object, and so on. データソースコントロールは、基になるデータのソースまたは形式に関係なく、データバインドコントロールに対して一貫した方法でデータを表示します。Data source controls present data in a consistent way to data-bound controls, regardless of the source or format of the underlying data.

ほとんどの Web 開発タスクを実行するには、ASP.NET でSqlDataSource提供されXmlDataSourceているデータソースコントロール (、、など) AccessDataSourceを使用します。You use the data source controls that are provided with ASP.NET, including SqlDataSource, AccessDataSource, and XmlDataSource, to perform most Web development tasks. 独自のカスタムデータDataSourceControlソースDataSourceViewコントロールを実装する場合は、基本クラスとクラスを使用します。You use the base DataSourceControl and DataSourceView classes when you want to implement your own custom data source control.

データソースコントロールは、 IDataSourceオブジェクトと、それに関連付けられたデータのリスト (データソースビュー) の組み合わせとして考えることができます。You can think of a data source control as the combination of the IDataSource object and its associated lists of data, called data source views. 各データのリストは、 DataSourceViewオブジェクトによって表されます。Each list of data is represented by a DataSourceView object. DataSourceViewクラスは、データソースコントロールに関連付けられているすべてのデータソースビューまたはデータの一覧の基本クラスです。The DataSourceView class is the base class for all data source views, or lists of data, associated with data source controls. データソースビューは、データソースコントロールの機能を定義します。Data source views define the capabilities of a data source control. 基になるデータストレージには1つ以上のデータのリストが含まれているので、データソースコントロールは、常に1つ以上の名前付きデータソースビューと関連付けられます。Because the underlying data storage contains one or more lists of data, a data source control is always associated with one or more named data source views. データソースコントロールは、 GetViewNamesメソッドを使用して、現在データソースコントロールに関連付けられているデータソースビューを列挙GetViewし、メソッドを使用して、特定のデータソースビューインスタンスを名前で取得します。The data source control uses the GetViewNames method to enumerate the data source views currently associated with the data source control and the GetView method to retrieve a specific data source view instance by name.

すべてDataSourceViewのオブジェクトは、 ExecuteSelectメソッドを使用して、基になるデータソースからのデータの取得をサポートします。All DataSourceView objects support data retrieval from the underlying data source using the ExecuteSelect method. 必要に応じてExecuteInsert、、 ExecuteUpdateExecuteDeleteなどの操作を含む、すべてのビューで基本的な操作のセットをサポートします。All views optionally support a basic set of operations, including operations such as ExecuteInsert, ExecuteUpdate, and ExecuteDelete. データバインドコントロールは、メソッドGetViewGetViewNamesメソッドを使用して関連付けられたデータソースビューを取得し、デザイン時または実行時にビューを照会することによって、データソースコントロールの機能を検出できます。A data-bound control can discover the capabilities of a data source control by retrieving an associated data source view using the GetView and GetViewNames methods, and by querying the view at design time or run time.

コンストラクター

DataSourceView(IDataSource, String) DataSourceView(IDataSource, String) DataSourceView(IDataSource, String) DataSourceView(IDataSource, String)

DataSourceView クラスの新しいインスタンスを初期化します。Initializes a new instance of the DataSourceView class.

プロパティ

CanDelete CanDelete CanDelete CanDelete

現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで ExecuteDelete(IDictionary, IDictionary) 操作がサポートされているかどうかを示す値を取得します。Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports the ExecuteDelete(IDictionary, IDictionary) operation.

CanInsert CanInsert CanInsert CanInsert

現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで ExecuteInsert(IDictionary) 操作がサポートされているかどうかを示す値を取得します。Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports the ExecuteInsert(IDictionary) operation.

CanPage CanPage CanPage CanPage

現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで、ExecuteSelect(DataSourceSelectArguments) メソッドで取得したデータを使用するページングがサポートされているかどうかを示す値を取得します。Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports paging through the data retrieved by the ExecuteSelect(DataSourceSelectArguments) method.

CanRetrieveTotalRowCount CanRetrieveTotalRowCount CanRetrieveTotalRowCount CanRetrieveTotalRowCount

現在の DataSourceControl オブジェクトに関連付けられた DataSourceView オブジェクトで、データではなく行の合計数を取得する操作がサポートされているかどうかを示す値を取得します。Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports retrieving the total number of data rows, instead of the data.

CanSort CanSort CanSort CanSort

現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで、基になるデータ ソースに対する並べ替え済みのビューがサポートされているかどうかを示す値を取得します。Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports a sorted view on the underlying data source.

CanUpdate CanUpdate CanUpdate CanUpdate

現在の DataSourceControl オブジェクトに関連付けられている DataSourceView オブジェクトで ExecuteUpdate(IDictionary, IDictionary, IDictionary) 操作がサポートされているかどうかを示す値を取得します。Gets a value indicating whether the DataSourceView object associated with the current DataSourceControl object supports the ExecuteUpdate(IDictionary, IDictionary, IDictionary) operation.

Events Events Events Events

データ ソース ビューのイベント ハンドラー デリゲートのリストを取得します。Gets a list of event-handler delegates for the data source view.

Name Name Name Name

データ ソース ビュー名を取得します。Gets the name of the data source view.

メソッド

CanExecute(String) CanExecute(String) CanExecute(String) CanExecute(String)

指定したコマンドを実行できるかどうかを判断します。Determines whether the specified command can be executed.

Delete(IDictionary, IDictionary, DataSourceViewOperationCallback) Delete(IDictionary, IDictionary, DataSourceViewOperationCallback) Delete(IDictionary, IDictionary, DataSourceViewOperationCallback) Delete(IDictionary, IDictionary, DataSourceViewOperationCallback)

DataSourceView オブジェクトで表されたデータのリストに対して、削除操作を非同期に実行します。Performs an asynchronous delete operation on the list of data that the DataSourceView object represents.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
ExecuteCommand(String, IDictionary, IDictionary) ExecuteCommand(String, IDictionary, IDictionary) ExecuteCommand(String, IDictionary, IDictionary) ExecuteCommand(String, IDictionary, IDictionary)

指定されたコマンドを実行します。Executes the specified command.

ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback) ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback) ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback) ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)

指定されたコマンドを実行します。Executes the specified command.

ExecuteDelete(IDictionary, IDictionary) ExecuteDelete(IDictionary, IDictionary) ExecuteDelete(IDictionary, IDictionary) ExecuteDelete(IDictionary, IDictionary)

DataSourceView オブジェクトで表されたデータのリストに対して、削除操作を実行します。Performs a delete operation on the list of data that the DataSourceView object represents.

ExecuteInsert(IDictionary) ExecuteInsert(IDictionary) ExecuteInsert(IDictionary) ExecuteInsert(IDictionary)

DataSourceView オブジェクトで表されたデータのリストに対して、挿入操作を実行します。Performs an insert operation on the list of data that the DataSourceView object represents.

ExecuteSelect(DataSourceSelectArguments) ExecuteSelect(DataSourceSelectArguments) ExecuteSelect(DataSourceSelectArguments) ExecuteSelect(DataSourceSelectArguments)

基になるデータ ストレージからデータのリストを取得します。Gets a list of data from the underlying data storage.

ExecuteUpdate(IDictionary, IDictionary, IDictionary) ExecuteUpdate(IDictionary, IDictionary, IDictionary) ExecuteUpdate(IDictionary, IDictionary, IDictionary) ExecuteUpdate(IDictionary, IDictionary, IDictionary)

DataSourceView オブジェクトで表されたデータのリストに対して、更新操作を実行します。Performs an update operation on the list of data that the DataSourceView object represents.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
Insert(IDictionary, DataSourceViewOperationCallback) Insert(IDictionary, DataSourceViewOperationCallback) Insert(IDictionary, DataSourceViewOperationCallback) Insert(IDictionary, DataSourceViewOperationCallback)

DataSourceView オブジェクトで表されたデータのリストに対して、挿入操作を非同期に実行します。Performs an asynchronous insert operation on the list of data that the DataSourceView object represents.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OnDataSourceViewChanged(EventArgs) OnDataSourceViewChanged(EventArgs) OnDataSourceViewChanged(EventArgs) OnDataSourceViewChanged(EventArgs)

DataSourceViewChanged イベントを発生させます。Raises the DataSourceViewChanged event.

RaiseUnsupportedCapabilityError(DataSourceCapabilities) RaiseUnsupportedCapabilityError(DataSourceCapabilities) RaiseUnsupportedCapabilityError(DataSourceCapabilities) RaiseUnsupportedCapabilityError(DataSourceCapabilities)

RaiseUnsupportedCapabilitiesError(DataSourceView) メソッドによって呼び出され、ビューでサポートされている機能と ExecuteSelect(DataSourceSelectArguments) 操作に必要な機能を比較します。Called by the RaiseUnsupportedCapabilitiesError(DataSourceView) method to compare the capabilities requested for an ExecuteSelect(DataSourceSelectArguments) operation against those that the view supports.

Select(DataSourceSelectArguments, DataSourceViewSelectCallback) Select(DataSourceSelectArguments, DataSourceViewSelectCallback) Select(DataSourceSelectArguments, DataSourceViewSelectCallback) Select(DataSourceSelectArguments, DataSourceViewSelectCallback)

基になるデータ ストレージからデータのリストを非同期に取得します。Gets a list of data asynchronously from the underlying data storage.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)
Update(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback) Update(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback) Update(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback) Update(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback)

DataSourceView オブジェクトで表されたデータのリストに対して、更新操作を非同期に実行します。Performs an asynchronous update operation on the list of data that the DataSourceView object represents.

イベント

DataSourceViewChanged DataSourceViewChanged DataSourceViewChanged DataSourceViewChanged

データ ソース ビューが変更された場合に発生します。Occurs when the data source view has changed.

適用対象

こちらもご覧ください