IWebPartField Arabirim

Tanım

Ad Alanı:

System.Web.UI.WebControls.WebParts

Bütünleştirilmiş Kod:

System.Web.dll

Tek bir veri alanı kullanarak iki sunucu denetimini bağlamak için bir sağlayıcı arabirimi tanımlar.

public interface class IWebPartField

public interface IWebPartField

type IWebPartField = interface

Public Interface IWebPartField

Türetilmiş

System.Web.UI.WebControls.WebParts.RowToFieldTransformer

Örnekler

Aşağıdaki kod örneği, arabirimini kullanarak IWebPartField iki denetim arasında statik bağlantı oluşturmayı gösterir. Kod örneğinin üç bölümü vardır:

• Arabirimini kullanarak bağlantı oluşturabilen iki özel WebPart denetimin IWebPartField kaynak kodu; bir denetim sağlayıcı, diğeri tüketici olarak hareket eder.

• Denetimleri barındıran ve statik bağlantıyı kalıcılık biçiminde bildiren bir Web sayfası.

• Örnek kod çalıştırıldığında ne olacağının açıklaması.

Kod örneğinin ilk bölümü, iki özel denetimin kaynak kodudur. İlk olarak, arabirimini uygulayan sağlayıcının IWebPartField kodudur. Örnekte kolaylık olması için sağlayıcı, veritabanına bağlanmak yerine bazı verilerle bir tablo oluşturur. GetConnectionInterface yöntemi, sağlayıcının bağlantı noktası olarak hizmet verir ve arabirim örneğini tüketiciye döndüren geri çağırma yöntemidir. Tüketiciye gelince, bir öznitelikle ConnectionConsumer işaretlenmiş adlı SetConnectionInterfaceyönteminde sağlayıcıdan arabirim örneğini alır. Arabirimin örneğini aldıktan sonra tüketici, yönteminde OnPreRender , gerçek verileri almak için sağlayıcıda yönteminin uygulamasını GetFieldValue çağırır.

Kod örneğinin çalışması için bu kaynak kodunu derlemeniz gerekir. Bunu açıkça derleyebilir ve sonuçta elde edilen derlemeyi Web sitenizin Bin klasörüne veya genel derleme önbelleğine yerleştirebilirsiniz. Alternatif olarak, kaynak kodu sitenizin App_Code klasörüne koyabilirsiniz; burada çalışma zamanında dinamik olarak derlenir. Bu kod örneği dinamik derleme kullanır. Derlemeyi gösteren bir izlenecek yol için bkz . İzlenecek Yol: Özel Web Sunucusu Denetimi Geliştirme ve Kullanma.

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

Kod örneğinin ikinci bölümü, statik bağlantıyı bildiren ve denetimleri barındıran Web sayfasıdır. Sayfanın üst kısmında, App_Code dizininde yer alan kaynak kodun ad alanını bildiren bir Register yönerge bulunur. Bağlantı bir <asp:webpartconnection> öğe kullanılarak bildirilir. Özel tüketici ve sağlayıcı denetimleri, bir öğenin içindeki bir <zonetemplate><asp:webpartzone> öğede bildirilir ve bu da bağlanabilmeleri için gereklidir (sınıftan WebPartZoneBase devralan bir bölgede bulunmalıdır).

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

Sayfayı bir tarayıcıda yükleyin. Tüketici denetimi, sağlayıcının arabirimin bir örneği aracılığıyla kullanılabilir hale getirdiği belirtilen alandan IWebPartField sağlanan verileri görüntüler.

Açıklamalar

Bu arabirim, Web Bölümleri bağlantılarıyla kullanılacak şekilde tasarlanmıştır. Web Bölümleri bağlantısında, bir WebPartZoneBase bölgede bulunan iki sunucu denetimi bir bağlantı kurar ve verileri paylaşır ve bir denetim tüketici, diğer denetim ise sağlayıcı görevi görür. Web Bölümleri bağlantısında veri paylaşma mekanizması, sağlayıcının bir geri çağırma yöntemi aracılığıyla tüketiciye hizmet ettiği bir arabirim örneğidir. Bağlantı kurmak için hem tüketicinin hem de sağlayıcının veri paylaşımı için aynı arabirim türüyle çalışması gerekir. Tüketici sağlayıcı tarafından gönderilen arabirim türünü tanımıyorsa, sağlayıcı tarafından gönderilen arabirim örneğini tüketicinin tanıdığı bir türe çeviren bir transformatör ( WebPartTransformer nesne) yoluyla denetimleri bağlamak yine de mümkündür. Bağlantılarla ilgili ayrıntılar için bkz WebPartConnection . ve Web Bölümleri Bağlantılarına Genel Bakış.

Arabirim IWebPartField , bir veri alanını temel alan bağlantılar oluşturmak için standart bir arabirim olarak ayarlanan Web Bölümleri denetimine dahil edilen bir sağlayıcı arabirimidir. Web Bölümleri bağlantılarıyla kullanmak için özel arabirimler de oluşturabilirsiniz, ancak birçok veri temelli Web uygulamasında, arabirimi kullanarak IWebPartField veri kaynağından ortak bir satıra (ayrıntılar için bkzIWebPartRow. arabirime), tabloya (ayrıntılar için arabirimine IWebPartTable bakın) veya alana dayalı bağlantılar oluşturmak yararlı olur. Tipik bir bağlantıda, sağlayıcı olarak davranan bir WebPart denetim arabirimi uygular IWebPartField ve özel bir geri çağırma yönteminde tüketicilere arabirimin bir örneğini sağlar. Örneğin sağlayıcı, kullanıcı bilgileri tablonuzda web IWebPartField kullanıcısının posta kodu verilerini içeren bir alan için arabirim uygulayabilir. Tüketici olarak davranan başka WebPart bir denetim, arabirim örneğini almak için özel bir yöntem tanımlar ve daha sonra posta kodu verilerini ayıklayabilir ve posta koduna göre hava durumu bilgilerini arayıp görüntüleyebilir.

Arabirimin IWebPartField kullanıma sunulan iki üyesi vardır. özelliği, Schema bir PropertyDescriptor nesnede kapsüllenen veri alanı hakkındaki şema bilgilerini döndürür. GetFieldValue yöntemi, bir uygulayıcının (sağlayıcı denetimi gibi) geri çağırma yöntemi çağrıldığında arabirim örneğinin alan verilerini almak için kullandığı bir yöntemi bildirir.

Özellikler

Schema

İki WebPart denetim arasında veri paylaşmak için kullanılan bir veri alanının şema bilgilerini alır.

Yöntemler

GetFieldValue(FieldCallback)

İki WebPart denetim arasındaki bağlantının temeli olarak arabirim tarafından kullanılan alanın değerini döndürür.

Ayrıca bkz.

• IWebPartRow
• IWebPartTable
• WebPartConnection
• Web Bölümleri Denetimlerini ASP.NET
• Web Bölümleri Bağlantılarına Genel Bakış