IWebPartField Rozhraní

Definice

Obor názvů:

System.Web.UI.WebControls.WebParts

Sestavení:

System.Web.dll

Definuje rozhraní zprostředkovatele pro připojení dvou serverových ovládacích prvků pomocí jednoho pole dat.

public interface class IWebPartField

public interface IWebPartField

type IWebPartField = interface

Public Interface IWebPartField

Odvozené

System.Web.UI.WebControls.WebParts.RowToFieldTransformer

Příklady

Následující příklad kódu ukazuje, jak vytvořit statické připojení mezi dvěma ovládacími prvky pomocí IWebPartField 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í IWebPartField 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 IWebPartField 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 GetFieldValue metody ve zprostředkovateli, aby načetl skutečná data.

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

    public FieldProviderWebPart() 
    {
        _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("FieldProvider")]
      public IWebPartField GetConnectionInterface()
    {
        return new FieldProviderWebPart();
    }

    public PropertyDescriptor Schema 
    {
        get 
        {
            /* The two parameters are row and field. Zero is the first record. 
                0,2 returns the zip code field value.   */ 
            return TypeDescriptor.GetProperties(_table.DefaultView[0])[2];
        }
    }

      void IWebPartField.GetFieldValue(FieldCallback callback) 
    {
        callback(Schema.GetValue(_table.DefaultView[0]));
    }
  } // end FieldProviderWebPart

  // This sample code creates a Web Parts control that acts as a consumer 
  // of an IWebPartField interface.
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class FieldConsumerWebPart : WebPart
  {

    private IWebPartField _provider;
    private object _fieldValue;

    private void GetFieldValue(object fieldValue)
    {
      _fieldValue = fieldValue;
    }

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

    protected override void OnPreRender(EventArgs e)
    {
      if (_provider != null)
      {
        _provider.GetFieldValue(new FieldCallback(GetFieldValue));
      }
      base.OnPreRender(e);
    }

    protected override void RenderContents(HtmlTextWriter writer)
    {

      if (_provider != null)
      {
        PropertyDescriptor prop = _provider.Schema;

        if (prop != null && _fieldValue != null)
        {
          writer.Write(prop.DisplayName + ": " + _fieldValue);
        }
        else
        {
          writer.Write("No data");
        }
      }
      else
      {
        writer.Write("Not connected");
      }
    }

    [ConnectionConsumer("FieldConsumer", "Connpoint1", 
      typeof(FieldConsumerConnectionPoint), AllowsMultipleConnections = true)]
    public void SetConnectionInterface(IWebPartField provider)
    {
      _provider = provider;
    }

    public class FieldConsumerConnectionPoint : ConsumerConnectionPoint
    {
      public FieldConsumerConnectionPoint(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 ((FieldConsumerWebPart)control).ConnectionPointEnabled;
      }
    } // end FieldConsumerConnectionPoint
  } // end FieldConsumerWebPart
} // end namespace 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 field data.
  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public NotInheritable Class FieldProviderWebPart
    Inherits WebPart
    Implements IWebPartField
    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("FieldProvider")> _
    Public Function GetConnectionInterface() As IWebPartField
      Return New FieldProviderWebPart()

    End Function


    Public ReadOnly Property Schema() As ComponentModel.PropertyDescriptor _
      Implements IWebPartField.Schema
      Get
        ' The two parameters are row and field. Zero is the first record. 
        ' 0,2 returns the zip code field value.   
        Return TypeDescriptor.GetProperties(_table.DefaultView(0))(2)
      End Get
    End Property


    Sub GetFieldValue(ByVal callback As FieldCallback) _
      Implements IWebPartField.GetFieldValue

      callback(Schema.GetValue(_table.DefaultView(0)))

    End Sub

  End Class


  ' This sample code creates a Web Parts control that acts as a 
  ' consumer of an IWebPartField interface.
  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class FieldConsumerWebPart
    Inherits WebPart

    Private _provider As IWebPartField
    Private _fieldValue As Object


    Private Sub GetFieldValue(ByVal fieldValue As Object)
      _fieldValue = fieldValue

    End Sub


    Public Property ConnectionPointEnabled() As Boolean
      Get
        Dim o As Object = ViewState("ConnectionPointEnabled")
        Return IIf(Not (o Is Nothing), CBool(o), True)
      End Get
      Set(ByVal value As Boolean)
        ViewState("ConnectionPointEnabled") = value
      End Set
    End Property


    Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
      If Not (_provider Is Nothing) Then
        _provider.GetFieldValue(New FieldCallback(AddressOf GetFieldValue))
      End If
      MyBase.OnPreRender(e)

    End Sub


    Protected Overrides Sub RenderContents(ByVal writer As _
      HtmlTextWriter)

      If Not (_provider Is Nothing) Then
        Dim prop As PropertyDescriptor = _provider.Schema

        If Not (prop Is Nothing) AndAlso Not (_fieldValue Is Nothing) Then
          writer.Write(prop.DisplayName & ": " & _fieldValue)
        Else
          writer.Write("No data")
        End If
      Else
        writer.Write("Not connected")
      End If

    End Sub

    <ConnectionConsumer("FieldConsumer", "Connpoint1", _
      GetType(FieldConsumerConnectionPoint), AllowsMultipleConnections:=True)> _
    Public Sub SetConnectionInterface(ByVal provider As IWebPartField)
      _provider = provider

    End Sub

  End Class

  Public Class FieldConsumerConnectionPoint
    Inherits ConsumerConnectionPoint

    Public Sub New(ByVal callbackMethod As MethodInfo, _
      ByVal interfaceType As Type, ByVal controlType As Type, _
      ByVal name As String, ByVal id As String, _
      ByVal allowsMultipleConnections As Boolean)
      MyBase.New(callbackMethod, interfaceType, controlType, _
        name, id, allowsMultipleConnections)

    End Sub


    Public Overrides Function GetEnabled(ByVal control As Control) _
      As Boolean

      Return CType(control, FieldConsumerWebPart).ConnectionPointEnabled

    End Function

  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="IField" 
    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">

<!-- This code sample creates a page with two Web Parts controls 
and establishes a connection between the controls. -->
<script runat="server">

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>IWebPartField Test Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:webpartmanager id="WebPartManager1" runat="server">
            <StaticConnections>
                <asp:WebPartConnection id="con1" ProviderID="provider1" 
                  ConsumerID="consumer1" 
                  ConsumerConnectionPointID="Connpoint1">
                </asp:WebPartConnection>
            </StaticConnections>
        </asp:webpartmanager>
        <asp:webpartzone id="WebPartZone1" runat="server">
            <zoneTemplate>
              <ifield:fieldproviderwebpart runat="Server" 
                ID="provider1" Title="Provider" />
              <ifield:fieldconsumerwebpart runat="Server" 
                ID="consumer1" Title="Consumer"/>
            </zoneTemplate>
        </asp:webpartzone>
    
    </div>
    </form>
</body>
</html>

<%@ page language="VB" debug="true" %>
<%@ Register tagprefix="IField" 
    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">

<!-- This code sample creates a page with two Web Parts controls 
and establishes a connection between the controls. -->
<script runat="server">

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>IWebPartField Test Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:webpartmanager id="WebPartManager1" runat="server">
            <StaticConnections>
                <asp:WebPartConnection id="con1" ProviderID="provider1" 
                  ConsumerID="consumer1" 
                  ConsumerConnectionPointID="Connpoint1">
                </asp:WebPartConnection>
            </StaticConnections>
        </asp:webpartmanager>
        <asp:webpartzone id="WebPartZone1" runat="server">
            <zoneTemplate>
              <ifield:fieldproviderwebpart runat="Server" 
                ID="provider1" Title="Provider" />
              <ifield:fieldconsumerwebpart runat="Server" 
                ID="consumer1" Title="Consumer"/>
            </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 pole, která poskytovatel zpřístupňuje prostřednictvím instance IWebPartField 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í IWebPartField 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 poli. 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é vytvořit připojení založená na společném řádku (podrobnosti najdete v IWebPartRow rozhraní), tabulce (podrobnosti najdete IWebPartTable v rozhraní) nebo poli ze zdroje dat pomocí rozhraní IWebPartField . V typickém připojení WebPart by ovládací prvek fungující jako zprostředkovatel implementoval IWebPartField rozhraní a poskytl instanci rozhraní příjemcům ve speciální metodě zpětného volání. Poskytovatel může například implementovat IWebPartField rozhraní pro pole v tabulce informací o uživateli, které obsahuje data PSČ webového uživatele. 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 data PSČ a vyhledat a zobrazit informace o počasí na základě PSČ.

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

Vlastnosti

Schema

Získá informace o schématu pro datové pole, které se používá ke sdílení dat mezi dvěma WebPart ovládacími prvky.

Metody

GetFieldValue(FieldCallback)

Vrátí hodnotu pole, které je používáno rozhraním jako základ spojení mezi dvěma WebPart ovládacími prvky.

Viz také

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