IWebPartRow Interfaz

Definición

Define una interfaz de proveedor para conectar dos controles de servidor mediante un único campo de datos.

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

Ejemplos

En el ejemplo de código siguiente se muestra cómo crear una conexión estática entre dos controles mediante la IWebPartRow interfaz . El ejemplo de código tiene tres partes:

  • Código fuente para dos controles personalizados WebPart que pueden formar una conexión mediante la IWebPartRow interfaz , con un control que actúa como proveedor y el otro que actúa como consumidor.

  • Página web que hospeda los controles y declara la conexión estática en formato de persistencia.

  • Descripción de lo que sucede cuando se ejecuta el código de ejemplo.

La primera parte del ejemplo de código es el código fuente de los dos controles personalizados. En primer lugar, es el código del proveedor, que implementa la IWebPartRow interfaz . Por motivos de simplicidad en el ejemplo, el proveedor crea una tabla con algunos datos en lugar de conectarse a una base de datos. El GetConnectionInterface método actúa como punto de conexión del proveedor, el método de devolución de llamada que devuelve la instancia de interfaz al consumidor. En cuanto al consumidor, recupera la instancia de interfaz del proveedor en su método denominado SetConnectionInterface, que se marca con un ConnectionConsumer atributo . Después de recuperar la instancia de la interfaz, el consumidor, en su OnPreRender método, llama a la implementación del GetRowData método en el proveedor, para recuperar los datos reales y escribirlos en la página.

Para que se ejecute el ejemplo de código, debe compilar este código fuente. Puede compilarlo explícitamente y colocar el ensamblado resultante en la carpeta Bin del sitio web o en la caché global de ensamblados. Como alternativa, puede colocar el código fuente en la carpeta App_Code del sitio, donde se compilará dinámicamente en tiempo de ejecución. En este ejemplo de código se usa la compilación dinámica. Para ver un tutorial que muestra cómo compilar, vea Tutorial: Desarrollo y uso de un control de servidor web personalizado.

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

La segunda parte del ejemplo de código es la página web que declara la conexión estática y hospeda los controles. Cerca de la parte superior de la página hay una Register directiva que declara el espacio de nombres del código fuente contenido en el directorio App_Code. La conexión se declara mediante un <asp:webpartconnection> elemento . Los controles de consumidor y proveedor personalizados se declaran en un <zonetemplate> elemento dentro de un <asp:webpartzone> elemento , que es necesario para que puedan conectarse (deben residir dentro de una zona que hereda de la WebPartZoneBase clase ).

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

Cargue la página en un explorador. El control de consumidor muestra los datos proporcionados desde la fila especificada, que el proveedor pone a disposición a través de una instancia de la IWebPartRow interfaz .

Comentarios

Esta interfaz está diseñada para usarse con conexiones elementos web. En una conexión de elementos web, dos controles de servidor que residen en una WebPartZoneBase zona establecen una conexión y comparten datos, con un control que actúa como consumidor y otro que actúa como proveedor. El mecanismo para compartir datos en una conexión de elementos web es una instancia de interfaz, que el proveedor sirve al consumidor mediante un método de devolución de llamada. Para establecer una conexión, el consumidor y el proveedor deben trabajar con el mismo tipo de interfaz para compartir datos. Si el consumidor no reconoce el tipo de interfaz enviado por el proveedor, todavía es posible conectar los controles mediante un transformador (un WebPartTransformer objeto) que traduce la instancia de interfaz enviada por el proveedor a un tipo que reconoce el consumidor. Para obtener más información sobre las conexiones, consulte WebPartConnection y elementos web Connections Overview(Introducción a las conexiones).

La IWebPartRow interfaz es una interfaz de proveedor incluida con el conjunto de controles elementos web como una interfaz estándar para crear conexiones basadas en una fila de datos. También puede crear interfaces personalizadas para usarlas con conexiones elementos web, pero en muchas aplicaciones web controladas por datos, resulta útil crear conexiones basadas en un campo común (para obtener más información, consulte la IWebPartField interfaz), tabla (para obtener más información, ver la IWebPartTable interfaz) o fila desde el origen de datos. En una conexión típica, un WebPart control que actúa como proveedor implementaría la IWebPartRow interfaz y proporcionaría una instancia de la interfaz a los consumidores en un método de devolución de llamada especial. Por ejemplo, el proveedor podría implementar una IWebPartRow interfaz para una fila que corresponda a un usuario de la tabla de información de usuario. Otro WebPart control que actúa como consumidor definiría un método especial para recibir la instancia de interfaz y, a continuación, podría extraer los datos de usuario, usarlo para buscar información adicional sobre las cuentas de ese usuario y mostrar toda la información relacionada con ese usuario en la página.

La IWebPartRow interfaz tiene dos miembros expuestos. La Schema propiedad devuelve información de esquema sobre la fila de datos encapsulada en un PropertyDescriptorCollection objeto . El GetRowData método declara un método que un implementador (como un control de proveedor) usa para recuperar los datos de fila de la instancia de interfaz cuando se invoca el método de devolución de llamada.

Propiedades

Schema

Obtiene la información del esquema de una fila de datos que se utiliza para compartir los datos entre dos controles WebPart.

Métodos

GetRowData(RowCallback)

Devuelve los datos de la fila que la interfaz está utilizando como base de una conexión entre dos controles WebPart.

Se aplica a

Consulte también