DataSourceView Classe

Definição

Namespace:

System.Web.UI

Assembly:

System.Web.dll

Serve como a classe base para todas as classes de exibição da fonte de dados, que definem os recursos dos controles de fonte de dados.

public ref class DataSourceView abstract

public abstract class DataSourceView

type DataSourceView = class

Public MustInherit Class DataSourceView

Herança

Object

DataSourceView

Derivado

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

Exemplos

O exemplo de código a seguir demonstra como estender a DataSourceView classe para criar uma classe de exibição fortemente tipada para um controle de fonte de dados. A CsVDataSourceView classe define os recursos do controle da fonte de CsvDataSource dados e fornece uma implementação para controles associados a dados usarem dados armazenados em arquivos de valores separados por vírgulas (.csv). Para obter mais informações sobre o controle da CsvDataSource fonte de dados, consulte a DataSourceControl classe .

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

Comentários

ASP.NET dá suporte a uma arquitetura de associação de dados que permite que os controles do servidor Web se associem aos dados de maneira consistente. Os controles de servidor Web que se associam aos dados são chamados de controles associados a dados e as classes que facilitam essa associação são chamadas de controles de fonte de dados. Os controles de fonte de dados podem representar qualquer fonte de dados: um banco de dados relacional, um arquivo, um fluxo, um objeto de negócios e assim por diante. Os controles de fonte de dados apresentam dados de maneira consistente para controles associados a dados, independentemente da origem ou formato dos dados subjacentes.

Você usa os controles de fonte de dados fornecidos com ASP.NET, incluindo SqlDataSource, AccessDataSourcee XmlDataSource, para executar a maioria das tarefas de desenvolvimento para a Web. Use as classes base DataSourceControl e DataSourceView quando quiser implementar seu próprio controle de fonte de dados personalizado.

Você pode pensar em um controle de fonte de dados como a combinação do IDataSource objeto e suas listas de dados associadas, chamadas exibições de fonte de dados. Cada lista de dados é representada por um DataSourceView objeto . A DataSourceView classe é a classe base para todas as exibições de fonte de dados, ou listas de dados, associadas a controles de fonte de dados. As exibições da fonte de dados definem os recursos de um controle da fonte de dados. Como o armazenamento de dados subjacente contém uma ou mais listas de dados, um controle de fonte de dados é sempre associado a uma ou mais exibições de fonte de dados nomeadas. O controle da fonte de dados usa o GetViewNames método para enumerar as exibições da fonte de dados atualmente associadas ao controle da fonte de dados e ao GetView método para recuperar uma instância de exibição da fonte de dados específica por nome.

Todos os DataSourceView objetos dão suporte à recuperação de dados da fonte de dados subjacente usando o ExecuteSelect método . Opcionalmente, todas as exibições dão suporte a um conjunto básico de operações, incluindo operações como ExecuteInsert, ExecuteUpdatee ExecuteDelete. Um controle associado a dados pode descobrir os recursos de um controle de fonte de dados recuperando uma exibição de fonte de dados associada usando os GetView métodos e GetViewNames e consultando a exibição em tempo de design ou em tempo de execução.

Construtores

DataSourceView(IDataSource, String)

Inicializa uma nova instância da classe DataSourceView.

Propriedades

CanDelete	Obtém um valor que indica se o objeto DataSourceView associado ao objeto DataSourceControl atual dá suporte à operação ExecuteDelete(IDictionary, IDictionary).
CanInsert	Obtém um valor que indica se o objeto DataSourceView associado ao objeto DataSourceControl atual dá suporte à operação ExecuteInsert(IDictionary).
CanPage	Obtém um valor que indica se o objeto DataSourceView associado ao objeto DataSourceControl atual dá suporte à paginação por meio da recuperação de dados pelo método ExecuteSelect(DataSourceSelectArguments).
CanRetrieveTotalRowCount	Obtém um valor que indica se o objeto DataSourceView associado ao objeto DataSourceControl atual dá suporte à recuperação do número total de linhas de dados em vez dos dados.
CanSort	Obtém um valor que indica se o objeto DataSourceView associado ao objeto DataSourceControl atual dá suporte a uma exibição classificada na fonte de dados subjacente.
CanUpdate	Obtém um valor que indica se o objeto DataSourceView associado ao objeto DataSourceControl atual dá suporte à operação ExecuteUpdate(IDictionary, IDictionary, IDictionary).
Events	Obtém uma lista de delegados de manipulador de eventos para a exibição da fonte de dados.
Name	Obtém o nome da exibição da fonte de dados.

Métodos

CanExecute(String)	Determina se o comando especificado pode ser executado.
Delete(IDictionary, IDictionary, DataSourceViewOperationCallback)	Executa uma operação de exclusão assíncrona na lista de dados que o objeto DataSourceView representa.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
ExecuteCommand(String, IDictionary, IDictionary)	Executa o comando especificado.
ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)	Executa o comando especificado.
ExecuteDelete(IDictionary, IDictionary)	Executa uma operação de exclusão na lista de dados que o objeto DataSourceView representa.
ExecuteInsert(IDictionary)	Executa uma operação de inserção na lista de dados que o objeto DataSourceView representa.
ExecuteSelect(DataSourceSelectArguments)	Obtém uma lista de dados do armazenamento de dados subjacente.
ExecuteUpdate(IDictionary, IDictionary, IDictionary)	Executa uma operação de atualização na lista de dados que o objeto DataSourceView representa.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
Insert(IDictionary, DataSourceViewOperationCallback)	Executa uma operação de inserção assíncrona na lista de dados que o objeto DataSourceView representa.
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
OnDataSourceViewChanged(EventArgs)	Aciona o evento DataSourceViewChanged.
RaiseUnsupportedCapabilityError(DataSourceCapabilities)	Chamado pelo método RaiseUnsupportedCapabilitiesError(DataSourceView) para comparar as funcionalidades solicitadas para uma operação ExecuteSelect(DataSourceSelectArguments) em relação às que a exibição dá suporte.
Select(DataSourceSelectArguments, DataSourceViewSelectCallback)	Obtém uma lista de dados de forma assíncrona do armazenamento de dados subjacente.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
Update(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback)	Executa uma operação de atualização assíncrona na lista de dados que o objeto DataSourceView representa.

Eventos

DataSourceViewChanged

Ocorre quando a exibição da fonte de dados foi alterada.

Confira também

• DataSourceControl
• HierarchicalDataSourceView