IWebPartRow Gränssnitt

Definition

public interface class IWebPartRow

public interface IWebPartRow

type IWebPartRow = interface

Public Interface IWebPartRow

Exempel

I följande kodexempel visas hur du skapar en statisk anslutning mellan två kontroller med hjälp av IWebPartRow gränssnittet. Kodexemplet har tre delar:

• Källkod för två anpassade WebPart kontroller som kan bilda en anslutning med hjälp av IWebPartRow gränssnittet, där den ena kontrollen fungerar som provider och den andra fungerar som konsument.

• En webbsida som är värd för kontrollerna och deklarerar den statiska anslutningen i beständighetsformat.

• En beskrivning av vad som händer när exempelkoden körs.

Den första delen av kodexemplet är källkoden för de två anpassade kontrollerna. Först är koden för providern, som implementerar IWebPartRow gränssnittet. För enkelhetens skull skapar providern en tabell med vissa data i stället för att ansluta till en databas. Metoden GetConnectionInterface fungerar som providerns anslutningspunkt, återanropsmetoden som returnerar gränssnittsinstansen till konsumenten. När det gäller konsumenten hämtar den gränssnittsinstansen från providern i metoden med namnet SetConnectionInterface, som är markerad med ett ConnectionConsumer attribut. När du har hämtat instansen av gränssnittet anropar konsumenten i sin OnPreRender metod implementeringen av GetRowData metoden i providern för att hämta faktiska data och skriva dem till sidan.

För att kodexemplet ska köras måste du kompilera den här källkoden. Du kan kompilera den explicit och placera den resulterande sammansättningen i webbplatsens bin-mapp eller den globala sammansättningscacheminnet. Du kan också placera källkoden i webbplatsens App_Code mapp, där den kompileras dynamiskt vid körning. I det här kodexemplet används dynamisk kompilering. En genomgång som visar hur du kompilerar finns i Genomgång: Utveckla och använda en anpassad webbserverkontroll.

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

Den andra delen av kodexemplet är webbsidan som deklarerar den statiska anslutningen och är värd för kontrollerna. Längst upp på sidan finns ett Register direktiv som deklarerar namnområdet för källkoden som finns i katalogen App_Code. Anslutningen deklareras med hjälp av ett <asp:webpartconnection> element. De anpassade konsument- och providerkontrollerna deklareras i ett <zonetemplate> element i ett <asp:webpartzone> element, vilket krävs för att de ska kunna ansluta (de måste finnas i en zon som ärver från WebPartZoneBase klassen).

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

Läs in sidan i en webbläsare. Konsumentkontrollen visar de data som tillhandahålls från den angivna raden, som providern gör tillgängliga via en instans av IWebPartRow gränssnittet.

Kommentarer

Det här gränssnittet är utformat för att användas med webbdelsanslutningar. I en webbdelsanslutning upprättar två serverkontroller som finns i en WebPartZoneBase zon en anslutning och delar data, där en kontroll fungerar som konsument och den andra kontrollen fungerar som leverantör. Mekanismen för att dela data i en webbdelsanslutning är en gränssnittsinstans som providern hanterar till konsumenten med hjälp av en återanropsmetod. För att upprätta en anslutning måste både konsumenten och leverantören arbeta med samma gränssnittstyp för att dela data. Om konsumenten inte känner igen den gränssnittstyp som skickas av providern är det fortfarande möjligt att ansluta kontrollerna med hjälp av en transformerare (ett WebPartTransformer objekt) som översätter gränssnittsinstansen som skickas av providern till en typ som konsumenten känner igen. Mer information om anslutningar finns i WebPartConnectionöversikten över anslutningar för webbdelar.

Gränssnittet IWebPartRow är ett providergränssnitt som ingår i kontrolluppsättningen webbdelar som ett standardgränssnitt för att skapa anslutningar baserat på en datarad. Du kan också skapa anpassade gränssnitt som ska användas med webbdelsanslutningar, men i många datadrivna webbprogram är det användbart att skapa anslutningar baserat på ett gemensamt fält (mer information finns i IWebPartField gränssnittet), tabell (mer information finns i IWebPartTable gränssnittet) eller rad från datakällan. I en typisk anslutning skulle en WebPart kontroll som fungerar som leverantör implementera IWebPartRow gränssnittet och tillhandahålla en instans av gränssnittet till konsumenter i en särskild återanropsmetod. Providern kan till exempel implementera ett IWebPartRow gränssnitt för en rad som motsvarar en användare i tabellen med användarinformation. En annan WebPart kontroll som fungerar som konsument skulle definiera en särskild metod för att ta emot gränssnittsinstansen och sedan extrahera användardata, använda dem för att söka efter ytterligare information om användarens konton och visa all information som är relaterad till användaren på sidan.

Gränssnittet IWebPartRow har två exponerade medlemmar. Egenskapen Schema returnerar schemainformation om dataraden som är inkapslad i ett PropertyDescriptorCollection objekt. Metoden GetRowData deklarerar en metod som en implementer (till exempel en providerkontroll) använder för att hämta gränssnittsinstansens raddata när motringningsmetoden anropas.

Se även

• WebPartConnection
• IWebPartField
• IWebPartTable
• ASP.NET webbdelskontroller
• Översikt över webbdelsanslutningar