DataSourceView Classe

Référence

Définition

Espace de noms:: System.Web.UI

Assembly:: System.Web.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Sert de classe de base pour toutes les classes d'affichage de source de données qui définissent les fonctions des contrôles de source de données.

public ref class DataSourceView abstract

public abstract class DataSourceView

type DataSourceView = class

Public MustInherit Class DataSourceView

Héritage: Object
DataSourceView

Dérivé: System.Web.UI.WebControls.EntityDataSourceView

System.Web.UI.WebControls.LinqDataSourceView

System.Web.UI.WebControls.ModelDataSourceView

System.Web.UI.WebControls.ObjectDataSourceView

System.Web.UI.WebControls.QueryableDataSourceView

Plus…

Exemples

L’exemple de code suivant montre comment étendre la DataSourceView classe pour créer une classe de vue fortement typée pour un contrôle de source de données. La CsVDataSourceView classe définit les fonctionnalités du CsvDataSource contrôle de source de données et fournit une implémentation pour les contrôles liés aux données afin d’utiliser des données stockées dans des fichiers de valeurs séparées par des virgules (.csv). Pour plus d’informations sur le CsvDataSource contrôle de source de données, consultez la 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

Remarques

ASP.NET prend en charge une architecture de liaison de données qui permet aux contrôles serveur web de lier des données de manière cohérente. Les contrôles de serveur web qui lient des données sont appelés contrôles liés aux données, et les classes qui facilitent cette liaison sont appelées contrôles de source de données. Les contrôles de source de données peuvent représenter n’importe quelle source de données : une base de données relationnelle, un fichier, un flux, un objet métier, etc. Les contrôles de source de données présentent les données de manière cohérente avec les contrôles liés aux données, quel que soit la source ou le format des données sous-jacentes.

Vous utilisez les contrôles de source de données fournis avec ASP.NET, notamment SqlDataSource, AccessDataSourceet XmlDataSource, pour effectuer la plupart des tâches de développement web. Vous utilisez les classes de base DataSourceControl et DataSourceView lorsque vous souhaitez implémenter votre propre contrôle de source de données personnalisé.

Vous pouvez considérer un contrôle de source de données comme la combinaison de l’objet IDataSource et de ses listes de données associées, appelées vues de source de données. Chaque liste de données est représentée par un DataSourceView objet . La DataSourceView classe est la classe de base pour toutes les vues de source de données, ou listes de données, associées aux contrôles de source de données. Les vues de source de données définissent les fonctionnalités d’un contrôle de source de données. Étant donné que le stockage de données sous-jacent contient une ou plusieurs listes de données, un contrôle de source de données est toujours associé à une ou plusieurs vues de sources de données nommées. Le contrôle de source de données utilise la GetViewNames méthode pour énumérer les vues de source de données actuellement associées au contrôle de source de données et la GetView méthode pour récupérer une vue de source de données spécifique instance par nom.

Tous les DataSourceView objets prennent en charge la récupération de données à partir de la source de données sous-jacente à l’aide de la ExecuteSelect méthode . Toutes les vues prennent éventuellement en charge un ensemble d’opérations de base, y compris les opérations telles que ExecuteInsert, ExecuteUpdateet ExecuteDelete. Un contrôle lié aux données peut découvrir les fonctionnalités d’un contrôle de source de données en récupérant une vue de source de données associée à l’aide des GetView méthodes et GetViewNames et en interrogeant la vue au moment de la conception ou de l’exécution.

Constructeurs

DataSourceView(IDataSource, String)

Initialise une nouvelle instance de la classe DataSourceView.

Propriétés

CanDelete	Obtient une valeur indiquant si l'objet DataSourceView associé à l'objet DataSourceControl actif prend en charge l'opération ExecuteDelete(IDictionary, IDictionary).
CanInsert	Obtient une valeur indiquant si l'objet DataSourceView associé à l'objet DataSourceControl actif prend en charge l'opération ExecuteInsert(IDictionary).
CanPage	Obtient une valeur indiquant si l'objet DataSourceView associé à l'objet en cours DataSourceControl prend en charge la consultation des données récupérées par la méthode ExecuteSelect(DataSourceSelectArguments).
CanRetrieveTotalRowCount	Obtient une valeur qui indique si l'objet DataSourceView associé à l'objet en cours DataSourceControl prend en charge la récupération du nombre total de lignes au lieu des données.
CanSort	Obtient une valeur indiquant si l'objet DataSourceView associé à l'objet en cours DataSourceControl prend en charge un affichage trié de la source de données sous-jacente.
CanUpdate	Obtient une valeur indiquant si l'objet DataSourceView associé à l'objet DataSourceControl actif prend en charge l'opération ExecuteUpdate(IDictionary, IDictionary, IDictionary).
Events	Obtient la liste des délégués de gestion d'événements pour l'affichage de source de données.
Name	Obtient le nom de l'affichage de source de données.

Méthodes

CanExecute(String)	Détermine si la commande spécifiée peut être exécutée.
Delete(IDictionary, IDictionary, DataSourceViewOperationCallback)	Exécute une opération de suppression asynchrone sur la liste des données que l'objet DataSourceView représente.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)	Exécute la commande spécifiée.
ExecuteCommand(String, IDictionary, IDictionary)	Exécute la commande spécifiée.
ExecuteDelete(IDictionary, IDictionary)	Exécute une opération de suppression sur la liste des données que l'objet DataSourceView représente.
ExecuteInsert(IDictionary)	Exécute une opération d'insertion dans la liste des données que l'objet DataSourceView représente.
ExecuteSelect(DataSourceSelectArguments)	Obtient une liste de données du stockage des données sous-jacent.
ExecuteUpdate(IDictionary, IDictionary, IDictionary)	Exécute une opération de mise à jour dans la liste des données que l'objet DataSourceView représente.
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
Insert(IDictionary, DataSourceViewOperationCallback)	Exécute une opération d'insertion asynchrone dans la liste des données que l'objet DataSourceView représente.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
OnDataSourceViewChanged(EventArgs)	Déclenche l’événement DataSourceViewChanged.
RaiseUnsupportedCapabilityError(DataSourceCapabilities)	Appelé par la méthode RaiseUnsupportedCapabilitiesError(DataSourceView) pour comparer les fonctions demandées pour une opération ExecuteSelect(DataSourceSelectArguments) à celles prises en charge par l'affichage.
Select(DataSourceSelectArguments, DataSourceViewSelectCallback)	Obtient une liste de données en mode asynchrone provenant du stockage des données sous-jacent.
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)
Update(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback)	Exécute une opération de mise à jour asynchrone dans la liste des données que l'objet DataSourceView représente.

Événements

DataSourceViewChanged

Se produit lorsque l'affichage de source de données a été modifié.

S’applique à

Partager via