IWebPartRow Rozhraní

Definice

public interface class IWebPartRow

public interface IWebPartRow

type IWebPartRow = interface

Public Interface IWebPartRow

Příklady

Následující příklad kódu ukazuje, jak vytvořit statické připojení mezi dvěma ovládacími prvky pomocí IWebPartRow rozhraní. Příklad kódu má tři části:

• Zdrojový kód pro dva vlastní WebPart ovládací prvky, které mohou vytvořit připojení pomocí IWebPartRow rozhraní, přičemž jeden ovládací prvek funguje jako zprostředkovatel a druhý jako příjemce.

• Webová stránka, která je hostitelem ovládacích prvků a deklaruje statické připojení ve formátu trvalosti.

• Popis toho, co se stane při spuštění ukázkového kódu.

První část příkladu kódu je zdrojový kód pro dva vlastní ovládací prvky. První je kód pro zprostředkovatele, který implementuje IWebPartRow rozhraní. Pro zjednodušení v tomto příkladu zprostředkovatel místo připojení k databázi vytvoří tabulku s některými daty. Metoda GetConnectionInterface slouží jako bod připojení zprostředkovatele, metoda zpětného volání, která vrací instanci rozhraní příjemci. Pokud jde o příjemce, načte instanci rozhraní od zprostředkovatele v metodě s názvem SetConnectionInterface, která je označena atributem ConnectionConsumer . Po načtení instance rozhraní příjemce ve své OnPreRender metodě volá implementaci GetRowData metody ve zprostředkovateli, načte skutečná data a zapíše je na stránku.

Aby se příklad kódu spustil, musíte tento zdrojový kód zkompilovat. Můžete ho explicitně zkompilovat a vložit výsledné sestavení do složky Bin webu nebo globální mezipaměti sestavení (GPA). Případně můžete zdrojový kód umístit do složky App_Code webu, kde se bude dynamicky kompilovat za běhu. Tento příklad kódu používá dynamickou kompilaci. Návod, který ukazuje, jak kompilovat, najdete v tématu Návod: Vývoj a použití vlastního ovládacího prvku webového serveru.

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

Druhou částí příkladu kódu je webová stránka, která deklaruje statické připojení a hostuje ovládací prvky. V horní části stránky je direktiva Register , která deklaruje obor názvů zdrojového kódu obsaženého v adresáři App_Code. Připojení je deklarováno pomocí elementu <asp:webpartconnection> . Vlastní ovládací prvky příjemce a zprostředkovatele jsou deklarovány v elementu <zonetemplate> v rámci elementu <asp:webpartzone> , který se vyžaduje, aby se mohly připojit (musí se nacházet v zóně, která dědí z WebPartZoneBase třídy ).

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

Načtěte stránku v prohlížeči. Ovládací prvek příjemce zobrazí data poskytnutá ze zadaného řádku, která poskytovatel zpřístupňuje prostřednictvím instance IWebPartRow rozhraní.

Poznámky

Toto rozhraní je navržené pro použití s připojeními webových částí. V připojení webových částí dva ovládací prvky serveru, které se nacházejí v WebPartZoneBase zóně, navazují připojení a sdílejí data, přičemž jeden ovládací prvek funguje jako příjemce a druhý ovládací prvek funguje jako zprostředkovatel. Mechanismus pro sdílení dat v připojení webových částí je instance rozhraní, kterou poskytovatel slouží příjemci prostřednictvím metody zpětného volání. Aby bylo možné navázat připojení, musí příjemce i poskytovatel pracovat se stejným typem rozhraní pro sdílení dat. Pokud příjemce nerozpozná typ rozhraní odeslaný poskytovatelem, je stále možné připojit ovládací prvky pomocí transformátoru (objektu WebPartTransformer ), který přeloží instanci rozhraní odeslanou poskytovatelem na typ, který příjemce rozpozná. Podrobnosti o připojeních najdete v tématu WebPartConnection a Přehled připojení webových částí.

Rozhraní IWebPartRow je rozhraní zprostředkovatele, které je součástí ovládacího prvku webové části nastaveného jako standardní rozhraní pro vytváření připojení založených na datovém řádku. Můžete také vytvořit vlastní rozhraní pro připojení webových částí, ale v mnoha webových aplikacích řízených daty je užitečné vytvářet připojení založená na společném poli (podrobnosti najdete v IWebPartField rozhraní), tabulce (podrobnosti najdete IWebPartTable v rozhraní) nebo řádku ze zdroje dat. V typickém připojení WebPart by ovládací prvek fungující jako zprostředkovatel implementoval IWebPartRow rozhraní a poskytl instanci rozhraní příjemcům ve speciální metodě zpětného volání. Zprostředkovatel může například implementovat IWebPartRow rozhraní pro řádek, který odpovídá uživateli v tabulce informací o uživateli. Jiný WebPart ovládací prvek fungující jako příjemce by definoval speciální metodu pro příjem instance rozhraní a pak by mohl extrahovat uživatelská data, použít je k vyhledání dalších informací o účtech daného uživatele a zobrazit všechny informace související s tímto uživatelem na stránce.

Rozhraní IWebPartRow má dva vystavené členy. Vlastnost Schema vrací informace schématu o řádku dat zapouzdřeném v objektu PropertyDescriptorCollection . Metoda GetRowData deklaruje metodu, kterou implementátor (například ovládací prvek zprostředkovatele) používá k načtení dat řádku instance rozhraní při vyvolání metody zpětného volání.

Vlastnosti

Metody

Platí pro

Viz také

• WebPartConnection
• IWebPartField
• IWebPartTable
• ASP.NET ovládací prvky webových částí
• Přehled připojení webových částí