DataSourceView Klasse

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.dll

Dient als Basisklasse für alle Datenquellenansichtsklassen, die die Funktionen von Datenquellensteuerelementen festlegen.

public ref class DataSourceView abstract

public abstract class DataSourceView

type DataSourceView = class

Public MustInherit Class DataSourceView

Vererbung

Object

DataSourceView

Abgeleitet

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

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie Sie die DataSourceView -Klasse erweitern, um eine stark typisierte Ansichtsklasse für ein Datenquellensteuerelement zu erstellen. Die CsVDataSourceView -Klasse definiert die Funktionen des CsvDataSource Datenquellensteuerelements und stellt eine Implementierung für datengebundene Steuerelemente bereit, um Daten zu verwenden, die in .csv-Dateien (kommagetrennte Werte) gespeichert sind. Weitere Informationen zum CsvDataSource Datenquellensteuerelement finden Sie in der DataSourceControl -Klasse.

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

Hinweise

ASP.NET unterstützt eine Datenbindungsarchitektur, die es Webserversteuerelementen ermöglicht, auf konsistente Weise an Daten zu binden. Webserversteuerelemente, die an Daten gebunden sind, werden als datengebundene Steuerelemente bezeichnet, und die Klassen, die diese Bindung erleichtern, werden als Datenquellensteuerelemente bezeichnet. Datenquellensteuerelemente können jede beliebige Datenquelle darstellen: eine relationale Datenbank, eine Datei, einen Stream, ein Geschäftsobjekt usw. Datenquellensteuerelemente stellen Daten unabhängig von der Quelle oder dem Format der zugrunde liegenden Daten auf konsistente Weise für datengebundene Steuerelemente dar.

Sie verwenden die Datenquellensteuerelemente, die mit ASP.NET bereitgestellt werden, einschließlich SqlDataSource, AccessDataSourceund XmlDataSource, zum Ausführen der meisten Webentwicklungsaufgaben. Sie verwenden die Basis DataSourceControl - und DataSourceView Klassen, wenn Sie Ein eigenes benutzerdefiniertes Datenquellensteuerelement implementieren möchten.

Sie können sich ein Datenquellensteuerelement als Kombination aus dem Objekt und den IDataSource zugeordneten Datenlisten vorstellen, die als Datenquellensichten bezeichnet werden. Jede Liste von Daten wird durch ein DataSourceView -Objekt dargestellt. Die DataSourceView -Klasse ist die Basisklasse für alle Datenquellensichten oder -listen, die Datenquellensteuerelementen zugeordnet sind. Datenquellensichten definieren die Funktionen eines Datenquellensteuerelements. Da der zugrunde liegende Datenspeicher eine oder mehrere Listen von Daten enthält, ist ein Datenquellensteuerelement immer einer oder mehreren benannten Datenquellensichten zugeordnet. Das Datenquellensteuerelement verwendet die GetViewNames -Methode, um die Datenquellensichten aufzulisten, die derzeit dem Datenquellensteuerelement und der GetView -Methode zugeordnet sind, um eine bestimmte Datenquellensicht instance nach Name abzurufen.

Alle DataSourceView Objekte unterstützen den Datenabruf aus der zugrunde liegenden Datenquelle mithilfe der ExecuteSelect -Methode. Alle Ansichten unterstützen optional einen grundlegenden Satz von Vorgängen, einschließlich Vorgängen wie ExecuteInsert, ExecuteUpdateund ExecuteDelete. Ein datengebundenes Steuerelement kann die Funktionen eines Datenquellensteuerelements ermitteln, indem eine zugeordnete Datenquellensicht mithilfe der GetView Methoden und GetViewNames abgerufen und die Ansicht zur Entwurfs- oder Laufzeitzeit abfragt.

Konstruktoren

DataSourceView(IDataSource, String)

Initialisiert eine neue Instanz der DataSourceView-Klasse.

Eigenschaften

CanDelete	Ruft einen Wert ab, der angibt, ob das DataSourceView-Objekt, das dem aktuellen DataSourceControl-Objekt zugeordnet ist, den ExecuteDelete(IDictionary, IDictionary)-Vorgang unterstützt.
CanInsert	Ruft einen Wert ab, der angibt, ob das DataSourceView-Objekt, das dem aktuellen DataSourceControl-Objekt zugeordnet ist, den ExecuteInsert(IDictionary)-Vorgang unterstützt.
CanPage	Ruft einen Wert ab, der angibt, ob das DataSourceView-Objekt, das dem aktuellen DataSourceControl-Objekt zugeordnet ist, Paging durch die Daten unterstützt, die von der ExecuteSelect(DataSourceSelectArguments)-Methode abgerufen wurden.
CanRetrieveTotalRowCount	Ruft einen Wert ab, der angibt, ob das DataSourceView-Objekt, das dem aktuellen DataSourceControl-Objekt zugeordnet ist, das Abrufen der Gesamtanzahl der Datenzeilen (anstelle der Daten) unterstützt.
CanSort	Ruft einen Wert ab, der angibt, ob das DataSourceView-Objekt, das dem aktuellen DataSourceControl-Objekt zugeordnet ist, eine sortierte Ansicht der zugrunde liegenden Datenquelle unterstützt.
CanUpdate	Ruft einen Wert ab, der angibt, ob das DataSourceView-Objekt, das dem aktuellen DataSourceControl-Objekt zugeordnet ist, den ExecuteUpdate(IDictionary, IDictionary, IDictionary)-Vorgang unterstützt.
Events	Ruft eine Liste von Ereignishandlerdelegaten für die Datenquellenansicht ab.
Name	Ruft den Namen der Datenquellenansicht ab.

Methoden

CanExecute(String)	Bestimmt, ob der angegebene Befehl ausgeführt werden kann.
Delete(IDictionary, IDictionary, DataSourceViewOperationCallback)	Führt einen asynchronen Löschvorgang in der Liste der Daten aus, die das DataSourceView-Objekt darstellt.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
ExecuteCommand(String, IDictionary, IDictionary)	Führt den angegebenen Befehl aus.
ExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)	Führt den angegebenen Befehl aus.
ExecuteDelete(IDictionary, IDictionary)	Führt einen Löschvorgang in der Liste der Daten aus, die das DataSourceView-Objekt darstellt.
ExecuteInsert(IDictionary)	Führt einen Einfügevorgang in der Liste der Daten aus, die das DataSourceView-Objekt darstellt.
ExecuteSelect(DataSourceSelectArguments)	Ruft eine Liste der Daten aus dem zugrunde liegenden Datenspeicher ab.
ExecuteUpdate(IDictionary, IDictionary, IDictionary)	Führt einen Aktualisierungsvorgang in der Liste der Daten aus, die das DataSourceView-Objekt darstellt.
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
Insert(IDictionary, DataSourceViewOperationCallback)	Führt einen asynchronen Einfügevorgang in der Liste der Daten aus, die das DataSourceView-Objekt darstellt.
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
OnDataSourceViewChanged(EventArgs)	Löst das DataSourceViewChanged-Ereignis aus.
RaiseUnsupportedCapabilityError(DataSourceCapabilities)	Durch die RaiseUnsupportedCapabilitiesError(DataSourceView)-Methode aufgerufen, um die für einen ExecuteSelect(DataSourceSelectArguments)-Vorgang erforderlichen Funktionen mit denen zu vergleichen, die die Ansicht unterstützt.
Select(DataSourceSelectArguments, DataSourceViewSelectCallback)	Ruft asynchron eine Liste der Daten aus dem zugrunde liegenden Datenspeicher ab.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
Update(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback)	Führt einen asynchronen Aktualisierungsvorgang in der Liste der Daten aus, die das DataSourceView-Objekt darstellt.

Ereignisse

DataSourceViewChanged

Tritt ein, wenn sich die Datenquellenansicht geändert hat.

Weitere Informationen

• DataSourceControl
• HierarchicalDataSourceView