IWebPartRow Interface

Definitie

public interface class IWebPartRow

public interface IWebPartRow

type IWebPartRow = interface

Public Interface IWebPartRow

Voorbeelden

In het volgende codevoorbeeld ziet u hoe u een statische verbinding tussen twee besturingselementen maakt met behulp van de IWebPartRow interface. Het codevoorbeeld heeft drie delen:

• Broncode voor twee aangepaste WebPart besturingselementen die een verbinding kunnen vormen met behulp van de IWebPartRow interface, met één besturingselement dat fungeert als de provider en de andere als consument.

• Een webpagina die als host fungeert voor de besturingselementen en de statische verbinding declareert in persistentie-indeling.

• Een beschrijving van wat er gebeurt wanneer de voorbeeldcode wordt uitgevoerd.

Het eerste deel van het codevoorbeeld is de broncode voor de twee aangepaste besturingselementen. Eerst is de code voor de provider, waarmee de IWebPartRow interface wordt geïmplementeerd. Ter vereenvoudiging in het voorbeeld maakt de provider een tabel met enkele gegevens in plaats van verbinding te maken met een database. De GetConnectionInterface methode fungeert als het verbindingspunt van de provider, de callback-methode die het interface-exemplaar retourneert naar de consument. Wat de consument betreft, wordt het interface-exemplaar opgehaald van de provider in de bijbehorende methode met de naam SetConnectionInterface, die is gemarkeerd met een ConnectionConsumer kenmerk. Na het ophalen van het exemplaar van de interface roept de consument in de OnPreRender bijbehorende methode de implementatie van de GetRowData methode in de provider aan om de werkelijke gegevens op te halen en naar de pagina te schrijven.

Als u het codevoorbeeld wilt uitvoeren, moet u deze broncode compileren. U kunt deze expliciet compileren en de resulterende assembly in de map Bin van uw website of de globale assemblycache plaatsen. U kunt de broncode ook in de map App_Code van uw site plaatsen, waar deze dynamisch wordt gecompileerd tijdens runtime. In dit codevoorbeeld wordt dynamische compilatie gebruikt. Zie Walkthrough: Een aangepast webserverbeheer ontwikkelen en gebruiken voor een overzicht van hoe u compileert.

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

Het tweede deel van het codevoorbeeld is de webpagina die de statische verbinding declareert en als host fungeert voor de besturingselementen. Boven aan de pagina bevindt zich een Register instructie die de naamruimte van de broncode in de App_Code directory declareert. De verbinding wordt gedeclareerd met behulp van een <asp:webpartconnection> element. De aangepaste besturingselementen voor consumenten en providers worden gedeclareerd in een <zonetemplate> element binnen een <asp:webpartzone> element, wat vereist is om verbinding te kunnen maken (ze moeten zich in een zone bevinden die van de WebPartZoneBase klasse overgaat).

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

Laad de pagina in een browser. Het consumentenbeheer geeft de gegevens weer die zijn opgegeven uit de opgegeven rij, die de provider beschikbaar maakt via een exemplaar van de IWebPartRow interface.

Opmerkingen

Deze interface is ontworpen voor gebruik met webonderdelenverbindingen. In een verbinding met webonderdelen maken twee serverbesturingselementen die zich in een WebPartZoneBase zone bevinden een verbinding tot stand en delen ze gegevens, waarbij één besturingselement fungeert als de consument en het andere besturingselement als provider fungeert. Het mechanisme voor het delen van gegevens in een webonderdelenverbinding is een interface-exemplaar, dat de provider aan de consument dient door middel van een callback-methode. Om een verbinding tot stand te brengen, moeten de consument en provider beide werken met hetzelfde interfacetype voor het delen van gegevens. Als de consument het interfacetype dat door de provider is verzonden niet herkent, is het nog steeds mogelijk om de besturingselementen te verbinden met behulp van een transformator (een WebPartTransformer object) waarmee het interface-exemplaar dat door de provider wordt verzonden, wordt omgezet in een type dat de consument herkent. Zie het overzicht van verbindingen en webonderdelen voor meer informatie over verbindingenWebPartConnection.

De IWebPartRow interface is een providerinterface die is opgenomen in het besturingselement webonderdelen dat is ingesteld als een standaardinterface voor het maken van verbindingen op basis van een gegevensrij. U kunt ook aangepaste interfaces maken voor gebruik met webonderdelenverbindingen, maar in veel gegevensgestuurde webtoepassingen is het handig om verbindingen te maken op basis van een gemeenschappelijk veld (zie de IWebPartField interface), tabel (zie de IWebPartTable interface) of rij uit de gegevensbron. In een typische verbinding zou een WebPart besturingselement dat fungeert als provider de IWebPartRow interface implementeren en een exemplaar van de interface bieden aan consumenten in een speciale callback-methode. De provider kan bijvoorbeeld een IWebPartRow interface implementeren voor een rij die overeenkomt met een gebruiker in de tabel met gebruikersgegevens. Een ander WebPart besturingselement dat als consument fungeert, definieert een speciale methode voor het ontvangen van het interface-exemplaar en kan vervolgens de gebruikersgegevens extraheren, gebruiken om aanvullende informatie over de accounts van die gebruiker op te zoeken en alle informatie weer te geven die betrekking heeft op die gebruiker op de pagina.

De IWebPartRow interface heeft twee blootgestelde leden. De Schema eigenschap retourneert schema-informatie over de gegevensrij die in een PropertyDescriptorCollection object is ingekapseld. De GetRowData methode declareert een methode die een implementer (zoals een providerbeheer) gebruikt om de rijgegevens van het interface-exemplaar op te halen wanneer de callback-methode wordt aangeroepen.

Zie ook

• WebPartConnection
• IWebPartField
• IWebPartTable
• ASP.NET besturingselementen voor webonderdelen
• Overzicht van webonderdelenverbindingen