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. Класс определяет возможности CsvDataSource элемента управления источниками данных и предоставляет реализацию элементов управления с привязкой к данным для использования данных, хранящихся в файлах значений с разделителями-запятыми (CSV). CsVDataSourceViewThe 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

Комментарии

ASP.NET поддерживает архитектуру привязки данных, которая позволяет серверным веб-элементам управления осуществлять последовательную привязку к данным.ASP.NET supports a data-binding architecture that enables Web server controls to bind to data in a consistent fashion. Элементы управления веб-сервера, которые привязаны к данным, называются элементами управления с привязкой к данным, а классы, которые упрощают эту привязку, называются элементами управления источниками данных.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.

Для выполнения большинства задач разработки веб-приложений используются элементы управления источниками SqlDataSourceданных AccessDataSource, предоставляемые вместе с ASP.NET, включая, и XmlDataSource.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. Поскольку базовое хранилище данных содержит один или несколько списков данных, элемент управления источника данных всегда связан с одним или несколькими представлениями источников данных с именем.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, ExecuteUpdateи ExecuteDelete.All views optionally support a basic set of operations, including operations such as ExecuteInsert, ExecuteUpdate, and ExecuteDelete. Элемент управления, привязанный к данным, может обнаруживать возможности элемента управления источниками данных, получая связанное представление источника данных GetView с GetViewNames помощью методов и, а также запрашивая представление во время разработки или во время выполнения.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

Получает значение, указывающее, поддерживает ли объект DataSourceView, связанный с текущим объектом DataSourceControl, операцию 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

Получает значение, указывающее, поддерживает ли объект DataSourceView, связанный с текущим объектом DataSourceControl, операцию 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

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

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

Возвращает значение, указывающее, поддерживает ли объект DataSourceView, связанный с текущим объектом DataSourceControl, отсортированное представление, на котором основывается источник базовых данных.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

Получает значение, указывающее, поддерживает ли объект DataSourceView, связанный с текущим объектом DataSourceControl, операцию 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.

Применяется к

Дополнительно