IWebPartRow Schnittstelle

Definition

Definiert eine Anbieterschnittstelle für das Verbinden von zwei Serversteuerelementen mit einem einzelnen Datenfeld.

public interface class IWebPartRow
public interface IWebPartRow
type IWebPartRow = interface
Public Interface IWebPartRow

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie Sie mithilfe der Schnittstelle eine statische Verbindung zwischen zwei Steuerelementen IWebPartRow erstellen. Das Codebeispiel umfasst drei Teile:

  • Quellcode für zwei benutzerdefinierte WebPart Steuerelemente, die eine Verbindung über die IWebPartRow Schnittstelle herstellen können, wobei ein Steuerelement als Anbieter und das andere als Consumer fungiert.

  • Eine Webseite, die die Steuerelemente hostet und die statische Verbindung im Persistenzformat deklariert.

  • Eine Beschreibung, was geschieht, wenn der Beispielcode ausgeführt wird.

Der erste Teil des Codebeispiels ist der Quellcode für die beiden benutzerdefinierten Steuerelemente. Zunächst ist der Code für den Anbieter, der die IWebPartRow Schnittstelle implementiert. Der Einfachheit halber erstellt der Anbieter im Beispiel eine Tabelle mit einigen Daten, anstatt eine Verbindung mit einer Datenbank herzustellen. Die GetConnectionInterface -Methode dient als Verbindungspunkt des Anbieters, die Rückrufmethode, die die Schnittstelleninstanz an den Consumer zurückgibt. Für den Consumer ruft er die Schnittstelleninstanz vom Anbieter in seiner Methode mit dem Namen SetConnectionInterfaceab, die mit einem ConnectionConsumer Attribut gekennzeichnet ist. Nach dem Abrufen der Instanz der Schnittstelle ruft der Consumer in seiner OnPreRender -Methode die Implementierung der GetRowData -Methode im Anbieter auf, um die tatsächlichen Daten abzurufen und auf die Seite zu schreiben.

Damit das Codebeispiel ausgeführt werden kann, müssen Sie diesen Quellcode kompilieren. Sie können sie explizit kompilieren und die resultierende Assembly im Ordner Bin ihrer Website oder im globalen Assemblycache ablegen. Alternativ können Sie den Quellcode im App_Code Ordner Ihrer Website ablegen, wo er zur Laufzeit dynamisch kompiliert wird. In diesem Codebeispiel wird die dynamische Kompilierung verwendet. Eine exemplarische Vorgehensweise, die das Kompilieren veranschaulicht, finden Sie unter Exemplarische Vorgehensweise: Entwickeln und Verwenden eines benutzerdefinierten Webserversteuerelements.

using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Reflection;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls 
{
  // This sample code creates a Web Parts control that acts as a provider 
  // of row data.
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public sealed class RowProviderWebPart : WebPart, IWebPartRow 
    {
    private DataTable _table;
    
    public RowProviderWebPart() 
        {
      _table = new DataTable();

      DataColumn col = new DataColumn();
      col.DataType = typeof(string);
      col.ColumnName = "Name";
      _table.Columns.Add(col);

      col = new DataColumn();
      col.DataType = typeof(string);
      col.ColumnName = "Address";
      _table.Columns.Add(col);

      col = new DataColumn();
      col.DataType = typeof(int);
      col.ColumnName = "ZIP Code";
      _table.Columns.Add(col);

      DataRow row = _table.NewRow();
      row["Name"] = "John Q. Public";
      row["Address"] = "123 Main Street";
      row["ZIP Code"] = 98000;
      _table.Rows.Add(row);
    }

    [ConnectionProvider("Row")]
    public IWebPartRow GetConnectionInterface()
        {
      return new RowProviderWebPart();
    }

    public PropertyDescriptorCollection Schema 
        {
      get 
      {
        return TypeDescriptor.GetProperties(_table.DefaultView[0]);
            }
    }

        public void GetRowData(RowCallback callback)
        {
            callback(_table.Rows);
        }
  } // RowProviderWebPart

  // This sample code creates a Web Parts control that acts as a consumer 
  // of row data.
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]  
  public sealed class RowConsumerWebPart : WebPart 
  {
    private IWebPartRow _provider;
        private ICollection _tableData;
    
        private void GetRowData(object rowData)
        {
            _tableData = (ICollection)rowData;
        }

        protected override void OnPreRender(EventArgs e)
        {
            if (_provider != null)
            {
                _provider.GetRowData(new RowCallback(GetRowData));
            }
        }

    protected override void RenderContents(HtmlTextWriter writer) 
    {
      if (_provider != null) 
      {
        PropertyDescriptorCollection props = _provider.Schema;
            int count = 0;
        if (props != null && props.Count > 0 && _tableData != null) 
        {
            foreach (PropertyDescriptor prop in props) 
                  {
                      foreach (DataRow o in _tableData)
                      {
                          writer.Write(prop.DisplayName + ": " + o[count]);
                          writer.WriteBreak();
                          writer.WriteLine();
                          count = count + 1;
                      }
            }
        }
        else 
        {
          writer.Write("No data");
        }
      }
      else 
      {
        writer.Write("Not connected");
      }
    }

    [ConnectionConsumer("Row")]
    public void SetConnectionInterface(IWebPartRow provider) 
        {
      _provider = provider;
    }
  } // RowConsumerWebPart
} // Samples.AspNet.CS.Controls
Imports System.Collections
Imports System.ComponentModel
Imports System.Data
Imports System.Reflection
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls

  ' This sample code creates a Web Parts control that acts as a provider 
  ' of row data.
  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public NotInheritable Class RowProviderWebPart
    Inherits WebPart
    Implements IWebPartRow
    Private _table As DataTable


    Public Sub New()
      _table = New DataTable()

      Dim col As New DataColumn()
      col.DataType = GetType(String)
      col.ColumnName = "Name"
      _table.Columns.Add(col)

      col = New DataColumn()
      col.DataType = GetType(String)
      col.ColumnName = "Address"
      _table.Columns.Add(col)

      col = New DataColumn()
      col.DataType = GetType(Integer)
      col.ColumnName = "ZIP Code"
      _table.Columns.Add(col)

      Dim row As DataRow = _table.NewRow()
      row("Name") = "John Q. Public"
      row("Address") = "123 Main Street"
      row("ZIP Code") = 98000
      _table.Rows.Add(row)

    End Sub


    <ConnectionProvider("Row")> _
    Public Function GetConnectionInterface() As IWebPartRow
      Return New RowProviderWebPart()

    End Function 'GetConnectionInterface


    Public ReadOnly Property Schema() As _
      ComponentModel.PropertyDescriptorCollection Implements IWebPartRow.Schema

      Get
        Return TypeDescriptor.GetProperties(_table.DefaultView(0))
      End Get

    End Property


    Public Sub GetRowData(ByVal callback As RowCallback) _
      Implements IWebPartRow.GetRowData
      callback(_table.Rows)

    End Sub

  End Class


  ' This sample code creates a Web Parts control that acts as a consumer 
  ' of row data.
  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public NotInheritable Class RowConsumerWebPart
    Inherits WebPart
    Private _provider As IWebPartRow
    Private _tableData As ICollection


    Private Sub GetRowData(ByVal rowData As Object)
      _tableData = CType(rowData, ICollection)

    End Sub


    Protected Overrides Sub OnPreRender(ByVal e As EventArgs)

      If Not (_provider Is Nothing) Then
        _provider.GetRowData(New RowCallback(AddressOf GetRowData))
      End If

    End Sub

    Protected Overrides Sub RenderContents(ByVal writer As HtmlTextWriter)

      If Not (_provider Is Nothing) Then
        Dim props As PropertyDescriptorCollection = _provider.Schema
        Dim count As Integer = 0
        If Not (props Is Nothing) AndAlso props.Count > 0 _
          AndAlso Not (_tableData Is Nothing) Then

          Dim prop As PropertyDescriptor
          For Each prop In props
            Dim o As DataRow
            For Each o In _tableData
              writer.Write(prop.DisplayName & ": " & o(count))
              writer.WriteBreak()
              writer.WriteLine()
              count = count + 1
            Next o
          Next prop
        Else
          writer.Write("No data")
        End If
      Else
        writer.Write("Not connected")
      End If

    End Sub


    <ConnectionConsumer("Row")> _
    Public Sub SetConnectionInterface(ByVal provider As IWebPartRow)
      _provider = provider

    End Sub

  End Class

End Namespace  ' Samples.AspNet.VB.Controls

Der zweite Teil des Codebeispiels ist die Webseite, die die statische Verbindung deklariert und die Steuerelemente hostet. Oben auf der Seite befindet sich eine Register Direktive, die den Namespace des Quellcodes deklariert, der im Verzeichnis App_Code enthalten ist. Die Verbindung wird mithilfe eines <asp:webpartconnection> -Elements deklariert. Die benutzerdefinierten Consumer- und Anbietersteuerelemente werden in einem <zonetemplate> Element innerhalb eines <asp:webpartzone> Elements deklariert, was erforderlich ist, damit sie eine Verbindung herstellen können (sie müssen sich in einer Zone befinden, die von der WebPartZoneBase -Klasse erbt).

<%@ page language="C#" %>
<%@ Register tagprefix="IRow" 
    Namespace="Samples.AspNet.CS.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>IRow Test Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:webpartmanager ID="WebPartManager1" runat="server">
        <staticconnections>
          <asp:webpartconnection ID="wp1" ProviderID="provider1" 
            ConsumerID="consumer1">
          </asp:webpartconnection>
        </staticconnections>
      </asp:webpartmanager>
       
        <asp:webpartzone ID="WebPartZone1" runat="server">
          <ZoneTemplate>
            <irow:RowProviderWebPart ID="provider1" runat="server" 
              Title="Row Provider Control" />
            <irow:RowConsumerWebPart ID="consumer1" runat="server" 
              Title="Row Consumer Control" />
          </ZoneTemplate>
        </asp:webpartzone>
    </div>
    </form>
</body>
</html>
<%@ page language="VB" %>
<%@ Register tagprefix="IRow" 
    Namespace="Samples.AspNet.VB.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>IRow Test Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:webpartmanager ID="WebPartManager1" runat="server">
        <staticconnections>
          <asp:webpartconnection ID="wp1" ProviderID="provider1" 
            ConsumerID="consumer1">
          </asp:webpartconnection>
        </staticconnections>
      </asp:webpartmanager>
       
        <asp:webpartzone ID="WebPartZone1" runat="server">
          <ZoneTemplate>
            <irow:RowProviderWebPart ID="provider1" runat="server" 
              Title="Row Provider Control" />
            <irow:RowConsumerWebPart ID="consumer1" runat="server" 
              Title="Row Consumer Control" />
          </ZoneTemplate>
        </asp:webpartzone>
    </div>
    </form>
</body>
</html>

Laden Sie die Seite in einen Browser. Das Consumersteuerelement zeigt die aus der angegebenen Zeile bereitgestellten Daten an, die der Anbieter über eine Instanz der IWebPartRow Schnittstelle verfügbar macht.

Hinweise

Diese Schnittstelle ist für die Verwendung mit Webpartverbindungen konzipiert. In einer Webparts-Verbindung stellen zwei Serversteuerelemente, die sich in einer WebPartZoneBase Zone befinden, eine Verbindung her und geben Daten frei, wobei ein Steuerelement als Consumer und das andere Steuerelement als Anbieter fungiert. Der Mechanismus zum Freigeben von Daten in einer Webpartverbindung ist eine Schnittstelleninstanz, die der Anbieter dem Consumer mithilfe einer Rückrufmethode bedient. Zum Herstellen einer Verbindung müssen Consumer und Anbieter für die Gemeinsame Nutzung von Daten mit demselben Schnittstellentyp arbeiten. Wenn der Consumer den vom Anbieter gesendeten Schnittstellentyp nicht erkennt, ist es trotzdem möglich, die Steuerelemente mithilfe eines Transformators (eines WebPartTransformer Objekts) zu verbinden, der die vom Anbieter gesendete Schnittstelleninstanz in einen Typ übersetzt, den der Consumer erkennt. Ausführliche Informationen zu Verbindungen finden Sie unter WebPartConnectionUnd Übersicht über Webpartsverbindungen.

Die IWebPartRow Schnittstelle ist eine Anbieterschnittstelle, die im Webpart-Steuerelementsatz als Standardschnittstelle zum Erstellen von Verbindungen basierend auf einer Datenzeile enthalten ist. Sie können auch benutzerdefinierte Schnittstellen erstellen, die mit Webpartverbindungen verwendet werden sollen. In vielen datengesteuerten Webanwendungen ist es jedoch nützlich, Verbindungen basierend auf einem gemeinsamen Feld (Details finden Sie in der IWebPartField Schnittstelle), einer Tabelle (details finden Sie in der IWebPartTable Schnittstelle) oder einer Zeile aus der Datenquelle. In einer typischen Verbindung implementiert ein WebPart Steuerelement, das als Anbieter fungiert, die IWebPartRow Schnittstelle und stellt eine Instanz der Schnittstelle für Consumer in einer speziellen Rückrufmethode bereit. Beispielsweise kann der Anbieter eine IWebPartRow Schnittstelle für eine Zeile implementieren, die einem Benutzer in Ihrer Benutzerinformationstabelle entspricht. Ein anderes WebPart Steuerelement, das als Consumer fungiert, würde eine spezielle Methode zum Empfangen der Schnittstelleninstanz definieren und dann die Benutzerdaten extrahieren, sie verwenden, um zusätzliche Informationen zu den Konten dieses Benutzers nachzuschlagen und alle Informationen zu diesem Benutzer auf der Seite anzuzeigen.

Die IWebPartRow Schnittstelle verfügt über zwei verfügbar gemachte Member. Die Schema -Eigenschaft gibt Schemainformationen zu der datenzeile zurück, die in einem PropertyDescriptorCollection -Objekt gekapselt ist. Die GetRowData -Methode deklariert eine Methode, die ein Implementierer (z. B. ein Anbietersteuerelement) verwendet, um die Zeilendaten der Schnittstelleninstanz abzurufen, wenn die Rückrufmethode aufgerufen wird.

Eigenschaften

Schema

Ruft die Schemainformationen für eine Datenzeile ab, mit deren Hilfe von zwei WebPart-Steuerelementen Daten gemeinsam verwendet werden können.

Methoden

GetRowData(RowCallback)

Gibt die Daten für die Zeile zurück, die von der Schnittstelle als Basis einer Verbindung zwischen zwei WebPart-Steuerelementen verwendet wird.

Gilt für:

Weitere Informationen