IWebPartField 인터페이스

참조

정의

네임스페이스:: System.Web.UI.WebControls.WebParts

어셈블리:: System.Web.dll

중요

일부 정보는 릴리스되기 전에 상당 부분 수정될 수 있는 시험판 제품과 관련이 있습니다. Microsoft는 여기에 제공된 정보에 대해 어떠한 명시적이거나 묵시적인 보증도 하지 않습니다.

단일 데이터 필드를 사용하여 두 서버 컨트롤을 연결할 수 있는 공급자 인터페이스를 정의합니다.

public interface class IWebPartField

public interface IWebPartField

type IWebPartField = interface

Public Interface IWebPartField

파생: System.Web.UI.WebControls.WebParts.RowToFieldTransformer

예제

다음 코드 예제에서는 인터페이스를 사용 하 여 IWebPartField 두 컨트롤 간에 정적 연결을 만드는 방법을 보여 줍니다. 이 코드 예제는 세 부분으로 구성 합니다.

인터페이스를 사용하여 연결을 형성할 수 있는 두 개의 사용자 지정 WebPart 컨트롤에 IWebPartField 대한 소스 코드이며, 한 컨트롤은 공급자 역할을 하고 다른 하나는 소비자 역할을 합니다.
컨트롤을 호스트하고 정적 연결을 지속성 형식으로 선언하는 웹 페이지입니다.
예제 코드가 실행되면 어떻게 되는지에 대한 설명입니다.

코드 예제의 첫 번째 부분은 두 사용자 지정 컨트롤에 대한 소스 코드입니다. 첫 번째는 인터페이스를 구현하는 공급자에 IWebPartField 대한 코드입니다. 예제에서 간단히 하기 위해 공급자는 데이터베이스에 연결하지 않고 일부 데이터가 포함된 테이블을 만듭니다. 메서드는 GetConnectionInterface 공급자의 연결 지점, 소비자에게 인터페이스 인스턴스를 반환하는 콜백 메서드 역할을 합니다. 소비자는 특성으로 표시된 메서드 SetConnectionInterface의 공급자에서 인터페이스 인스턴스를 ConnectionConsumer 검색합니다. 인터페이스의 인스턴스를 검색한 후 소비자는 메서드 OnPreRender 에서 공급자의 메서드 구현을 GetFieldValue 호출하여 실제 데이터를 검색합니다.

코드 예제를 실행하려면 이 소스 코드를 컴파일해야 합니다. 명시적으로 컴파일하고 결과 어셈블리를 웹 사이트의 Bin 폴더 또는 전역 어셈블리 캐시에 넣을 수 있습니다. 또는 런타임에 동적으로 컴파일되는 사이트의 App_Code 폴더에 소스 코드를 배치할 수 있습니다. 이 코드 예제에서는 동적 컴파일을 사용합니다. 컴파일 방법을 보여 주는 연습은 연습: 사용자 지정 웹 서버 컨트롤 개발 및 사용을 참조하세요.

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

코드 예제의 두 번째 부분은 정적 연결을 선언하고 컨트롤을 호스트하는 웹 페이지입니다. 페이지 맨 위에는 Register App_Code 디렉터리에 포함된 소스 코드의 네임스페이스를 선언하는 지시문이 있습니다. 연결은 요소를 사용하여 <asp:webpartconnection> 선언됩니다. 사용자 지정 소비자 및 공급자 컨트롤은 요소 내 <asp:webpartzone> 의 <zonetemplate> 요소에서 선언되며, 이 요소는 연결할 수 있어야 합니다(클래스에서 WebPartZoneBase 상속되는 영역 내에 있어야 합니다).

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

브라우저에서 페이지를 로드 합니다. 소비자 컨트롤은 공급자가 인터페이스의 인스턴스 IWebPartField 를 통해 사용할 수 있게 하는 지정된 필드에서 제공된 데이터를 표시합니다.

설명

이 인터페이스는 웹 파트 연결과 함께 사용하도록 설계되었습니다. 웹 파트 연결에서 영역에 있는 WebPartZoneBase 두 개의 서버 컨트롤은 연결을 설정하고 데이터를 공유하며, 한 컨트롤은 소비자 역할을 하고 다른 하나는 공급자 역할을 합니다. 웹 파트 연결에서 데이터를 공유하는 메커니즘은 공급자가 콜백 메서드를 통해 소비자에게 제공하는 인터페이스 인스턴스입니다. 연결을 설정하려면 소비자와 공급자가 모두 데이터를 공유하기 위해 동일한 인터페이스 형식으로 작업해야 합니다. 소비자가 공급자가 보낸 인터페이스 형식을 인식하지 못하는 경우에도 공급자가 보낸 인터페이스 인스턴스를 소비자가 인식하는 형식으로 변환하는 변환기( WebPartTransformer 개체)를 통해 컨트롤을 연결할 수 있습니다. 연결에 대한 자세한 내용은 및 웹 파트 연결 개요를 참조 WebPartConnection 하세요.

인터페이스는 IWebPartField 데이터 필드를 기반으로 연결을 만들기 위한 표준 인터페이스로 웹 파트 컨트롤 집합에 포함된 공급자 인터페이스입니다. 웹 파트 연결을 사용 하는 사용자 지정 인터페이스를 만들 수도 있습니다 하지만 대부분의 데이터 기반 웹 애플리케이션에서 일반적인 행을 기반으로 연결을 만드는 것이 유용할 것 (세부 정보를 참조 하세요. 합니다 IWebPartRow 인터페이스), 테이블 (세부 정보를 참조 하세요.를 IWebPartTable 인터페이스) 또는 데이터에서 필드를 사용 하 여 소스를 IWebPartField 인터페이스. 일반적인 연결 WebPart 에서 공급자 역할을 하는 컨트롤은 인터페이스를 IWebPartField 구현하고 특별한 콜백 메서드의 소비자에게 인터페이스 인스턴스를 제공합니다. 예를 들어 공급자는 웹 사용자의 우편 번호 데이터가 포함된 사용자 정보 테이블의 필드에 대한 인터페이스를 구현 IWebPartField 할 수 있습니다. 소비자 역할을 하는 또 다른 WebPart 컨트롤은 인터페이스 인스턴스를 수신하는 특수 메서드를 정의한 다음 우편 번호 데이터를 추출하고 우편 번호를 기반으로 날씨 정보를 조회하고 표시할 수 있습니다.

인터페이스에는 IWebPartField 두 개의 노출된 멤버가 있습니다. 속성은 Schema 개체에 캡슐화된 PropertyDescriptor 데이터 필드에 대한 스키마 정보를 반환합니다. 메서드는 GetFieldValue 콜백 메서드가 호출될 때 구현자(예: 공급자 컨트롤)가 인터페이스 인스턴스의 필드 데이터를 검색하는 데 사용하는 메서드를 선언합니다.

속성

Schema

두 개의 WebPart 컨트롤 간에 데이터를 공유하는 데 사용되는 데이터 필드의 스키마 정보를 가져옵니다.

메서드

GetFieldValue(FieldCallback)

인터페이스에서 두 WebPart 컨트롤 사이의 기본 연결로 사용하고 있는 필드 값을 반환합니다.

적용 대상

다음을 통해 공유

IWebPartField 인터페이스

정의

예제

설명

속성

메서드

적용 대상

추가 정보

추가 리소스