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 поддерживает архитектуру привязки данных, которая позволяет веб-серверным элементам управления согласованно выполнять привязку к данным. Элементы управления веб-сервера, которые привязываются к данным, называются элементами управления с привязкой к данным, а классы, упрощающие привязку, называются элементами управления источником данных. Элементы управления источником данных могут представлять любой источник данных: реляционную базу данных, файл, поток, бизнес-объект и т. д. Элементы управления источником данных представляют данные согласованно для элементов управления, привязанных к данным, независимо от источника или формата базовых данных.

Для выполнения большинства задач веб-разработки используются элементы управления источником данных, предоставляемые с ASP.NET, включая SqlDataSource, AccessDataSourceи XmlDataSource. Базовые DataSourceControl классы и DataSourceView используются для реализации собственного пользовательского элемента управления источником данных.

Элемент управления источником данных можно рассматривать как сочетание IDataSource объекта и связанных с ним списков данных, называемых представлениями источников данных. Каждый список данных представлен DataSourceView объектом . Класс DataSourceView является базовым классом для всех представлений источников данных или списков данных, связанных с элементами управления источником данных. Представления источников данных определяют возможности элемента управления источником данных. Так как базовое хранилище данных содержит один или несколько списков данных, элемент управления источником данных всегда связан с одним или несколькими именованными представлениями источников данных. Элемент управления источником данных использует GetViewNames метод для перечисления представлений источников данных, связанных в настоящее время с элементом управления источником данных, и GetView метод для получения определенного экземпляра представления источника данных по имени.

Все DataSourceView объекты поддерживают получение данных из базового источника данных с помощью ExecuteSelect метода . Все представления при необходимости поддерживают базовый набор операций, включая такие операции, как ExecuteInsert, ExecuteUpdateи ExecuteDelete. Элемент управления с привязкой к данным может обнаруживать возможности элемента управления источником данных, извлекая связанное представление источника данных с помощью GetView методов и , GetViewNames а также запрашивая представление во время разработки или во время выполнения.

Конструкторы

DataSourceView(IDataSource, String)

Инициализирует новый экземпляр класса DataSourceView.

Свойства

CanDelete	Получает значение, указывающее, поддерживает ли объект DataSourceView, связанный с текущим объектом DataSourceControl, операцию ExecuteDelete(IDictionary, IDictionary).
CanInsert	Получает значение, указывающее, поддерживает ли объект DataSourceView, связанный с текущим объектом DataSourceControl, операцию ExecuteInsert(IDictionary).
CanPage	Возвращает значение, указывающее, поддерживает ли объект DataSourceView, связанный с текущим объектом DataSourceControl, разбиение на страницы данных, извлеченных с помощью метода ExecuteSelect(DataSourceSelectArguments).
CanRetrieveTotalRowCount	Возвращает значение, указывающее, поддерживает ли объект DataSourceView связанный с текущим объектом DataSourceControl, извлечение общего количества строк данных вместо самих данных.
CanSort	Возвращает значение, указывающее, поддерживает ли объект DataSourceView, связанный с текущим объектом DataSourceControl, отсортированное представление, на котором основывается источник базовых данных.
CanUpdate	Получает значение, указывающее, поддерживает ли объект DataSourceView, связанный с текущим объектом DataSourceControl, операцию ExecuteUpdate(IDictionary, IDictionary, IDictionary).
Events	Возвращает список делегатов обработчиков событий представления источника данных.
Name	Возвращает имя представления источника данных.

Методы

CanExecute(String)	Определяет, может ли быть выполнена указанная команда.
Delete(IDictionary, IDictionary, DataSourceViewOperationCallback)	Выполняет операцию асинхронного удаления в списке данных, представляющем объект DataSourceView.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
ExecuteCommand(String, IDictionary, IDictionary)	Выполняет указанную команду.
ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)	Выполняет указанную команду.
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