IWebPartField インターフェイスとは? わかりやすく解説

Weblio 辞書 > コンピュータ > .NET Framework クラス ライブラリ リファレンス > IWebPartField インターフェイスの意味・解説 

IWebPartField インターフェイス

メモ : このインターフェイスは、.NET Framework version 2.0新しく追加されたものです。

単一データ フィールド使用して 2 つサーバー コントロール接続するためのプロバイダ インターフェイス定義します

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文構文

Dim instance As IWebPartField
public interface IWebPartField
public interface class IWebPartField
public interface IWebPartField
public interface IWebPartField
解説解説

このインターフェイスは、Web パーツ接続での使用意図してデザインされています。Web パーツ接続では、WebPartZoneBase ゾーン内にある 2 つサーバー コントロール接続確立しデータ共有しますその際一方コントロールコンシューマとして機能し、もう一方コントロールプロバイダとして機能しますWeb パーツ接続データ共有するための機構インターフェイス インスタンスで、プロバイダからコールバック メソッドによってコンシューマ提供されます。接続確立するためには、コンシューマプロバイダ両方が、データ共有のための同じインターフェイス型対応している必要がありますプロバイダから送信されインターフェイス型コンシューマ認識しない場合でも、プロバイダから送信されインターフェイス インスタンスコンシューマ認識する型に変換するトランスフォーマ (WebPartTransformer オブジェクト) により、コントロール接続できます接続詳細については、「WebPartConnection」および「Web パーツ接続概要」を参照してください

IWebPartField インターフェイスは、データ フィールド基づいて接続作成するための標準インターフェイスとして Web パーツ コントロール セット含まれるプロバイダ インターフェイスです。カスタムインターフェイス作成して Web パーツ接続使用することもできますが、多くデータ ドリブン Web アプリケーションでは、IWebPartField インターフェイス使用して、共通の行 (詳細については、IWebPartRow インターフェイストピック参照)、テーブル (詳細については、IWebPartTable インターフェイストピック参照)、またはデータ ソースフィールドに基づく接続作成すると便利です。一般的な接続では、プロバイダとして機能する WebPart コントロールIWebPartField インターフェイス実装し、このインターフェイスインスタンスを、特殊なコールバック メソッドによってコンシューマ提供します。たとえば、プロバイダが、Web ユーザー郵便番号データ格納されているユーザー情報テーブル内のフィールドIWebPartField インターフェイス実装しているとしますコンシューマとして機能する別の WebPart コントロールは、このインターフェイス インスタンス受け取特殊なメソッド定義し郵便番号データ抽出し郵便番号に基づく気象情報検索して表示できます

IWebPartField インターフェイスには 2 つ公開されメンバありますSchema プロパティは、PropertyDescriptor オブジェクトカプセル化されているデータ フィールドに関するスキーマ情報返します。GetFieldValue メソッドは、コールバック メソッド呼び出されるときに、インターフェイス インスタンスフィールド データ取得するために実装側 (プロバイダ コントロールなど) が使用するメソッド宣言します

使用例使用例

IWebPartField インターフェイス使用して2 つコントロール間で静的接続作成する方法次のコード例示しますコード例は、次の 3 つの部分から成ります

コード例最初部分は、2 つカスタム コントロールソース コードです。最初コードは、IWebPartField インターフェイス実装するプロバイダコードです。例を簡略化するために、プロバイダデータベース接続するではなくいくつかのデータ格納するテーブル作成してます。GetConnectionInterface メソッドは、コンシューマインターフェイス インスタンス返すコールバック メソッドである、プロバイダコネクション ポイントとして機能しますコンシューマは、ConnectionConsumer 属性マークされている SetConnectionInterface という名前のメソッド内で、プロバイダからのインターフェイス インスタンス取得しますインターフェイスインスタンス取得した後、コンシューマは、その OnPreRender メソッド内でプロバイダGetFieldValue メソッド実装呼び出し実際のデータ取得します

コード例実行するためには、このソース コードコンパイルする必要があります。それを明示的にコンパイルし、コンパイル済みアセンブリWeb サイトBin フォルダまたはグローバル アセンブリ キャッシュ配置できますサイトの App_Code フォルダソース コード配置し実行時動的にコンパイルすることもできます。このコード例は、動的コンパイル使用しますコンパイル方法を示すチュートリアルについては、「チュートリアル : カスタム サーバー コントロール開発と使用」を参照してください

Imports System
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 '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
    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 'FieldConsumerWebPart

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

End Namespace  ' Samples.AspNet.VB.Controls
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

コード例2 番目の部分は、静的接続宣言しコントロールホストする Web ページです。ページの上部には、App_Code ディレクトリ格納されているソース コード名前空間宣言する Register ディレクティブ含まれています。接続は、<asp:webpartconnection> 要素使用して宣言されます。カスタム コンシューマ コントロールカスタム プロバイダ コントロールは、<asp:webpartzone> 要素内の <zonetemplate> 要素宣言されています。これは、これらのコントロール接続できるようにするために必要な要素です (これらのコントロールは、WebPartZoneBase クラスから継承されるゾーン配置されている必要があります)。

<%@ 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  >
<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="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  >
<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 インターフェイスインスタンス通じて提供する特定のフィールドからのデータ表示します

.NET Framework のセキュリティ.NET Frameworkセキュリティ
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照
関連項目
IWebPartField メンバ
System.Web.UI.WebControls.WebParts 名前空間
IWebPartRow
IWebPartTable
WebPartConnection
その他の技術情報
ASP.NET Web パーツ ページ
Web パーツ接続概要



英和和英テキスト翻訳>> Weblio翻訳
英語⇒日本語日本語⇒英語
  

辞書ショートカット

すべての辞書の索引

「IWebPartField インターフェイス」の関連用語

IWebPartField インターフェイスのお隣キーワード
検索ランキング

   

英語⇒日本語
日本語⇒英語
   



IWebPartField インターフェイスのページの著作権
Weblio 辞書 情報提供元は 参加元一覧 にて確認できます。

   
日本マイクロソフト株式会社日本マイクロソフト株式会社
© 2025 Microsoft.All rights reserved.

©2025 GRAS Group, Inc.RSS