IWebPartField Interface

Definitie

Naamruimte:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Belangrijk

Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.

Definieert een providerinterface voor het verbinden van twee serverbesturingselementen met behulp van één gegevensveld.

public interface class IWebPartField

public interface IWebPartField

type IWebPartField = interface

Public Interface IWebPartField

Afgeleid: System.Web.UI.WebControls.WebParts.RowToFieldTransformer

Voorbeelden

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

Broncode voor twee aangepaste WebPart besturingselementen die een verbinding kunnen vormen met behulp van de IWebPartField interface, waarbij één besturingselement fungeert als de provider, de andere als de consument fungeert.
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 IWebPartField 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 GetFieldValue methode in de provider aan om de werkelijke gegevens op te halen.

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

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

Laad de pagina in een browser. Het consumentenbeheer geeft de gegevens weer die zijn opgegeven uit het opgegeven veld, die de provider beschikbaar maakt via een exemplaar van de IWebPartField 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 WebPartConnection meer informatie over verbindingen.

De IWebPartField interface is een providerinterface die is opgenomen in het besturingselement Webonderdelen dat als standaardinterface is ingesteld voor het maken van verbindingen op basis van een gegevensveld. 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 gemeenschappelijke rij (zie de interface), de IWebPartRow tabel (zie de IWebPartTable interface) of het veld van de gegevensbron met behulp van de IWebPartField interface. In een typische verbinding zou een WebPart besturingselement dat fungeert als provider de IWebPartField interface implementeren en een exemplaar van de interface bieden aan consumenten in een speciale callback-methode. De provider kan bijvoorbeeld een IWebPartField interface implementeren voor een veld in de tabel met gebruikersgegevens die de postcodegegevens van een webgebruiker bevatten. Een ander WebPart besturingselement dat als consument fungeert, zou een speciale methode definiëren om het interface-exemplaar te ontvangen en vervolgens de postcodegegevens te extraheren en weerinformatie op te zoeken en weer te geven op basis van de postcode.

De IWebPartField interface heeft twee blootgestelde leden. De Schema eigenschap retourneert schemagegevens over het gegevensveld dat is ingekapseld in een PropertyDescriptor object. De GetFieldValue methode declareert een methode die een implementer (zoals een providerbeheer) gebruikt om de veldgegevens van het interface-exemplaar op te halen wanneer de callback-methode wordt aangeroepen.

Eigenschappen

Name	Description
Schema	Hiermee haalt u de schemagegevens op voor een gegevensveld dat wordt gebruikt voor het delen van gegevens tussen twee WebPart besturingselementen.

Methoden

Name	Description
GetFieldValue(FieldCallback)	Retourneert de waarde van het veld dat door de interface wordt gebruikt als basis van een verbinding tussen twee WebPart besturingselementen.

Van toepassing op

Zie ook

Feedback

Is deze pagina nuttig?