IWebPartTable Schnittstelle

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Definiert eine Anbieterschnittstelle für das Verbinden von zwei Serversteuerelementen mit einer ganzen Tabelle von Daten.

C#

public interface IWebPartTable

Beispiele

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

• Quellcode für zwei benutzerdefinierte WebPart Steuerelemente, die mithilfe der IWebPartTable -Schnittstelle eine Verbindung 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. Zuerst ist der Code für den Anbieter, der die IWebPartTable -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. Was den Consumer angeht, 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 GetTableData -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 Ordner App_Code 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.

C#

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 table data.
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
    public sealed class TableProviderWebPart : WebPart, IWebPartTable
    {
        DataTable _table;

        public TableProviderWebPart()
        {
            _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);
        }

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

        public void GetTableData(TableCallback callback)
        {
                callback(_table.Rows);
        }

        public bool ConnectionPointEnabled
        {
            get
            {
                object o = ViewState["ConnectionPointEnabled"];
                return (o != null) ? (bool)o : true;
            }
            set
            {
                ViewState["ConnectionPointEnabled"] = value;
            }
        }

        [ConnectionProvider("Table", typeof(TableProviderConnectionPoint), 
      AllowsMultipleConnections = true)]
        public IWebPartTable GetConnectionInterface()
        {
            return new TableProviderWebPart();
        }

        public class TableProviderConnectionPoint : ProviderConnectionPoint
        {
            public TableProviderConnectionPoint(MethodInfo callbackMethod, 
        Type interfaceType, Type controlType, string name, string id, 
        bool allowsMultipleConnections) 
        : base(callbackMethod, interfaceType, controlType, name, id, 
          allowsMultipleConnections)
            {
            }

            public override bool GetEnabled(Control control)
            {
                return ((TableProviderWebPart)control).ConnectionPointEnabled;
            }
        }
    }

  // This code sample creates a Web Parts control that acts as a consumer 
  // of information provided by the TableProvider.ascx control.
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class TableConsumer : WebPart
  {
    private IWebPartTable _provider;
    private ICollection _tableData;

    private void GetTableData(object tableData)
    {
      _tableData = (ICollection)tableData;
    }

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

    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("Table")]
    public void SetConnectionInterface(IWebPartTable provider)
    {
      _provider = provider;
    }

    public class TableConsumerConnectionPoint : ConsumerConnectionPoint
    {
      public TableConsumerConnectionPoint(MethodInfo callbackMethod,
        Type interfaceType, Type controlType, string name, string id,
        bool allowsMultipleConnections)
        : base(callbackMethod, interfaceType, controlType, name, id,
        allowsMultipleConnections)
      {
      }
    } // TableConsumerConnectionPoint
  } // TableConsumer
} // Samples.AspNet.CS.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).

ASP.NET (C#)

<%@ 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>

Laden Sie die Seite in einen Browser. Das Consumer-Steuerelement zeigt die daten aus der angegebenen Tabelle an, die der Anbieter über eine Instanz der IWebPartTable -Schnittstelle zur Verfügung stellt.

Hinweise

Diese Schnittstelle ist für die Verwendung mit Webparts-Verbindungen 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 Webparts-Verbindung ist eine Schnittstelleninstanz, die der Anbieter dem Consumer mithilfe einer Rückrufmethode zur Seite stellt. Um eine Verbindung herzustellen, müssen Consumer und Anbieter beide mit demselben Schnittstellentyp arbeiten, um Daten freizugeben. Wenn der Consumer den vom Anbieter gesendeten Schnittstellentyp nicht erkennt, ist es dennoch 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 IWebPartTable Schnittstelle ist eine Anbieterschnittstelle, die im Webparts-Steuerelementsatz als Standardschnittstelle zum Erstellen von Verbindungen basierend auf einer Datentabelle enthalten ist. Sie können auch benutzerdefinierte Schnittstellen für die Verwendung mit Webparts-Verbindungen erstellen, aber in vielen datengesteuerten Webanwendungen ist es nützlich, Verbindungen basierend auf einem gemeinsamen Feld (details finden Sie in der IWebPartField Schnittstelle), zeile (weitere Informationen finden Sie in der IWebPartRow Schnittstelle) oder tabelle aus der Datenquelle. In einer typischen Verbindung würde ein WebPart Steuerelement, das als Anbieter fungiert, die IWebPartTable Schnittstelle implementieren und eine Instanz der Schnittstelle für Consumer in einer speziellen Rückrufmethode bereitstellen. Der Anbieter kann beispielsweise eine IWebPartTable Schnittstelle für eine Tabelle implementieren, die Finanzleistungsdaten enthält. Ein anderes WebPart Steuerelement, das als Consumer fungiert, würde eine spezielle Methode zum Empfangen der Schnittstelleninstanz definieren und dann die Daten extrahieren und ein Diagramm rendern, um die resultierenden Informationen anzuzeigen.

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

Eigenschaften

Schema

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

Methoden

GetTableData(TableCallback)

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

Gilt für:

Weitere Informationen

• WebPartConnection
• IWebPartField
• IWebPartRow
• ASP.NET Webparts-Steuerelemente
• Übersicht über Webpartsverbindungen