IWebPartField Interfaccia

Definizione

Definisce un'interfaccia provider per la connessione di due controlli server tramite un singolo campo di dati.Defines a provider interface for connecting two server controls using a single field of data.

public interface class IWebPartField
public interface IWebPartField
type IWebPartField = interface
Public Interface IWebPartField
Derivato

Esempi

Nell'esempio di codice riportato di seguito viene illustrato come creare una connessione statica tra due IWebPartField controlli utilizzando l'interfaccia.The following code example demonstrates how to create a static connection between two controls using the IWebPartField interface. L'esempio di codice è costituito da tre parti:The code example has three parts:

  • Codice sorgente per due controlli WebPart personalizzati che possono formare una connessione utilizzando l' IWebPartField interfaccia, con un controllo che funge da provider, l'altro che funge da consumer.Source code for two custom WebPart controls that can form a connection using the IWebPartField interface, with one control acting as the provider, the other acting as the consumer.

  • Pagina Web che ospita i controlli e dichiara la connessione statica nel formato di persistenza.A Web page that hosts the controls and declares the static connection in persistence format.

  • Descrizione di cosa accade quando viene eseguito il codice di esempio.A description of what happens when the example code runs.

La prima parte dell'esempio di codice è il codice sorgente per i due controlli personalizzati.The first part of the code example is the source code for the two custom controls. Il primo è il codice per il provider, che implementa IWebPartField l'interfaccia.First is the code for the provider, which implements the IWebPartField interface. Per semplicità nell'esempio, il provider crea una tabella con alcuni dati anziché connettersi a un database.For simplicity in the example, the provider creates a table with some data rather than connecting to a database. Il GetConnectionInterface metodo funge da punto di connessione del provider, il metodo di callback che restituisce l'istanza dell'interfaccia al consumer.The GetConnectionInterface method serves as the provider's connection point, the callback method that returns the interface instance to the consumer. Come per il consumer, recupera l'istanza dell'interfaccia dal provider nel metodo denominato SetConnectionInterface, contrassegnato con un ConnectionConsumer attributo.As for the consumer, it retrieves the interface instance from the provider in its method named SetConnectionInterface, which is marked with a ConnectionConsumer attribute. Dopo aver recuperato l'istanza dell'interfaccia, il consumer, nel OnPreRender metodo, chiama l'implementazione GetFieldValue del metodo nel provider per recuperare i dati effettivi.After retrieving the instance of the interface, the consumer, in its OnPreRender method, calls the implementation of the GetFieldValue method in the provider, to retrieve the actual data.

Per eseguire l'esempio di codice, è necessario compilare questo codice sorgente.For the code example to run, you must compile this source code. È possibile compilarlo in modo esplicito e inserire l'assembly risultante nella cartella bin del sito Web o nel Global Assembly Cache.You can compile it explicitly and put the resulting assembly in your Web site's Bin folder or the global assembly cache. In alternativa, è possibile inserire il codice sorgente nella cartella App_Code del sito, in cui verrà compilato dinamicamente in fase di esecuzione.Alternatively, you can put the source code in your site's App_Code folder, where it will be dynamically compiled at run time. In questo esempio di codice viene utilizzata la compilazione dinamica.This code example uses dynamic compilation. Per una procedura dettagliata che illustra come eseguire la compilazione , vedere Procedura dettagliata: Sviluppo e utilizzo di un controlloserver Web personalizzato.For a walkthrough that demonstrates how to compile, see Walkthrough: Developing and Using a Custom Web Server Control.

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

La seconda parte dell'esempio di codice è la pagina Web che dichiara la connessione statica e ospita i controlli.The second part of the code example is the Web page that declares the static connection and hosts the controls. Nella parte superiore della pagina è presente una Register direttiva che dichiara lo spazio dei nomi del codice sorgente contenuto nella directory App_Code.Near the top of the page is a Register directive that declares the namespace of the source code contained in the App_Code directory. La connessione viene dichiarata <asp:webpartconnection> utilizzando un elemento.The connection is declared using an <asp:webpartconnection> element. I controlli consumer e provider personalizzati sono dichiarati in <zonetemplate> un <asp:webpartzone> elemento all'interno di un elemento, che è necessario per consentire la connessione (devono risiedere all'interno di una WebPartZoneBase zona che eredita dalla classe).The custom consumer and provider controls are declared in a <zonetemplate> element within an <asp:webpartzone> element, which is required for them to be able to connect (they must reside within a zone that inherits from the WebPartZoneBase class).

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

Caricare la pagina in un browser.Load the page in a browser. Il controllo consumer Visualizza i dati forniti dal campo specificato, che il provider rende disponibile tramite un'istanza dell' IWebPartField interfaccia.The consumer control displays the data provided from the specified field, which the provider makes available through an instance of the IWebPartField interface.

Commenti

Questa interfaccia è progettata per essere utilizzata con connessioni Web part.This interface is designed to be used with Web Parts connections. In una connessione Web part, due controlli server che si trovano in una WebPartZoneBase zona stabiliscono una connessione e condividono i dati, con un controllo che funge da consumer e l'altro controllo che funge da provider.In a Web Parts connection, two server controls that reside in a WebPartZoneBase zone establish a connection and share data, with one control acting as the consumer and the other control acting as a provider. Il meccanismo di condivisione dei dati in una connessione Web part è un'istanza di interfaccia, che il provider serve al consumer per mezzo di un metodo di callback.The mechanism for sharing data in a Web Parts connection is an interface instance, which the provider serves to the consumer by means of a callback method. Per stabilire una connessione, il consumer e il provider devono entrambi funzionare con lo stesso tipo di interfaccia per la condivisione dei dati.To establish a connection, the consumer and provider must both work with the same interface type for sharing data. Se il consumer non riconosce il tipo di interfaccia inviato dal provider, è comunque possibile connettere i controlli per mezzo di un trasformatore (un WebPartTransformer oggetto) che converte l'istanza dell'interfaccia inviata dal provider in un tipo che il consumer riconosce.If the consumer does not recognize the interface type sent by the provider, it is still possible to connect the controls by means of a transformer (a WebPartTransformer object) that translates the interface instance sent by the provider into a type that the consumer recognizes. Per informazioni dettagliate sulle connessioni, WebPartConnection vedere e Web part panoramica delle connessioni.For details on connections, see WebPartConnection and Web Parts Connections Overview.

L' IWebPartField interfaccia è un'interfaccia del provider inclusa nel set di controlli Web part come interfaccia standard per la creazione di connessioni basate su un campo di dati.The IWebPartField interface is a provider interface included with the Web Parts control set as a standard interface for creating connections based on a data field. È inoltre possibile creare interfacce personalizzate da utilizzare con le connessioni Web part, ma in molte applicazioni Web basate sui dati è utile creare connessioni basate su una riga comune (per informazioni dettagliate, vedere l' IWebPartRow interfaccia), tabella (per informazioni dettagliate, vedere IWebPartTable interfaccia), o campo dall'origine dati, utilizzando l' IWebPartField interfaccia.You can also create custom interfaces to use with Web Parts connections, but in many data-driven Web applications, it is useful to create connections based on a common row (for details, see the IWebPartRow interface), table (for details, see the IWebPartTable interface), or field from the data source, using the IWebPartField interface. In una connessione tipica, un WebPart controllo che funge da provider implementa l' IWebPartField interfaccia e fornisce un'istanza dell'interfaccia ai consumer in un metodo di callback speciale.In a typical connection, a WebPart control acting as a provider would implement the IWebPartField interface and provide an instance of the interface to consumers in a special callback method. Ad esempio, il provider può implementare un' IWebPartField interfaccia per un campo nella tabella delle informazioni utente che contiene i dati del codice postale di un utente Web.For example, the provider might implement an IWebPartField interface for a field in your user information table that contains a Web user's postal code data. Un WebPart altro controllo che funge da consumer definirebbe un metodo speciale per ricevere l'istanza dell'interfaccia e potrebbe quindi estrarre i dati del codice postale e cercare e visualizzare le informazioni meteorologiche in base al CAP.Another WebPart control acting as a consumer would define a special method to receive the interface instance, and could then extract the postal code data, and look up and display weather information based on the postal code.

L' IWebPartField interfaccia dispone di due membri esposti.The IWebPartField interface has two exposed members. La Schema proprietà restituisce le informazioni sullo schema sul campo dati incapsulato PropertyDescriptor in un oggetto.The Schema property returns schema information about the data field encapsulated in a PropertyDescriptor object. Il GetFieldValue metodo dichiara un metodo utilizzato da un implementatore (ad esempio un controllo del provider) per recuperare i dati del campo dell'istanza di interfaccia quando viene richiamato il metodo di callback.The GetFieldValue method declares a method that an implementer (such as a provider control) uses to retrieve the interface instance's field data when the callback method is invoked.

Proprietà

Schema

Ottiene le informazioni sullo schema per un campo dati utilizzato per condividere i dati tra due controlli WebPart.Gets the schema information for a data field that is used to share data between two WebPart controls.

Metodi

GetFieldValue(FieldCallback)

Restituisce il valore del campo utilizzato dall'interfaccia come base di una connessione tra due controlli WebPart.Returns the value of the field that is being used by the interface as the basis of a connection between two WebPart controls.

Si applica a

Vedi anche