ConsumerConnectionPoint コンストラクター

リファレンス

定義

名前空間:: System.Web.UI.WebControls.WebParts

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ConsumerConnectionPoint クラスの新しいインスタンスを初期化します。

public:
 ConsumerConnectionPoint(System::Reflection::MethodInfo ^ callbackMethod, Type ^ interfaceType, Type ^ controlType, System::String ^ displayName, System::String ^ id, bool allowsMultipleConnections);

public ConsumerConnectionPoint (System.Reflection.MethodInfo callbackMethod, Type interfaceType, Type controlType, string displayName, string id, bool allowsMultipleConnections);

new System.Web.UI.WebControls.WebParts.ConsumerConnectionPoint : System.Reflection.MethodInfo * Type * Type * string * string * bool -> System.Web.UI.WebControls.WebParts.ConsumerConnectionPoint

Public Sub New (callbackMethod As MethodInfo, interfaceType As Type, controlType As Type, displayName As String, id As String, allowsMultipleConnections As Boolean)

パラメーター

callbackMethod: MethodInfo

接続を確立するためのインターフェイスインスタンスをコンシューマーに返す、コンシューマーコントロールのメソッド。

interfaceType: Type

コンシューマーがプロバイダーから受け取るインターフェイスの Type。

controlType: Type

コンシューマー接続ポイントが関連付けられたコンシューマーコントロールの Type。

displayName: String

接続ユーザーインターフェイス (UI) でユーザーに対して表示される、コンシューマー接続ポイントの表示名。

id: String

コンシューマー接続ポイントの一意な識別子。

allowsMultipleConnections: Boolean

コンシューマー接続ポイントが、プロバイダーとの間で同時に複数の接続を持つことができるかどうかを示すブール値。

例外

ArgumentNullException

callbackMethod が nullです。

または

interfaceType は null です。

または

controlType は null です。

- または -

displayName は null または空の文字列 ("") です。

ArgumentException

controlType が、コンシューマーコントロール (またはそれから派生した有効なクラス) と同じ型ではありません。

例

次のコード例では、クラスから ConsumerConnectionPoint 派生してカスタムプロバイダー接続ポイントを作成する方法を示します。

このコード例には、次の 3 つの部分があります。

プロバイダー WebPart コントロール、コンシューマー WebPart コントロール、およびカスタム ConsumerConnectionPoint オブジェクトを含むソースファイル。
静的接続でコントロールをホストする Web ページ。
サンプルコードを実行する方法の説明。

コード例の最初の部分は、プロバイダーコントロールとコンシューマー WebPart コントロールのソースと、という名前TableConsumerConnectionPointのカスタム ConsumerConnectionPoint クラスです。クラスのコンストラクターは、基本コンストラクターを TableConsumerConnectionPoint 呼び出し、Parameters セクションで示されているように必要なパラメーターを渡すことに注意してください。また、 TableConsumer クラスでは、 SetConnectionInterface メソッドが接続のコールバックメソッドとして指定され、属性によって ConnectionConsumer カスタム TableConsumerConnectionPoint がパラメーターとして宣言されることにも注意してください。これは、カスタムコンシューマー接続ポイントを作成し、それをコンシューマーコントロールに関連付ける方法を示しています。この例では、ソースコードが動的にコンパイルされていることを前提としているため、ソースコードファイルを Web アプリケーションのApp_Codeサブフォルダーに配置する必要があります。

using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Reflection;
using System.Web;
using System.Web.UI;
using System.Security.Permissions;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

//This sample code creates a Web Parts control that acts as a provider of table data.
namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
    public sealed class TableProviderWebPart : WebPart, IWebPartTable
    {
        DataTable _table;

        public TableProviderWebPart()
        {
            _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);
        }

        public PropertyDescriptorCollection Schema
        {
            get
            {
                return TypeDescriptor.GetProperties(_table.DefaultView[0]);
            }
        }
        public void GetTableData(TableCallback callback)
        {
                callback(_table.Rows);
        }

        public bool ConnectionPointEnabled
        {
            get
            {
                object o = ViewState["ConnectionPointEnabled"];
                return (o != null) ? (bool)o : true;
            }
            set
            {
                ViewState["ConnectionPointEnabled"] = value;
            }
        }

        [ConnectionProvider("Table", typeof(TableProviderConnectionPoint), AllowsMultipleConnections = true)]
        public IWebPartTable GetConnectionInterface()
        {
            return new TableProviderWebPart();
        }

        public class TableProviderConnectionPoint : ProviderConnectionPoint
        {
            public TableProviderConnectionPoint(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 ((TableProviderWebPart)control).ConnectionPointEnabled;
            }
        }
    }
    
    // This code sample demonstrates a custom WebPart controls that acts as 
    // a consumer in a Web Parts connection.
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class TableConsumer : WebPart
  {
    private IWebPartTable _provider;
    private ICollection _tableData;

    private void GetTableData(object tableData)
    {
      _tableData = (ICollection)tableData;
    }

    protected override void OnPreRender(EventArgs e)
    {
      if (_provider != null)
      {
        _provider.GetTableData(new TableCallback(GetTableData));
      }
    }

    protected override void RenderContents(HtmlTextWriter writer)
    {
      if (_provider != null)
      {
        PropertyDescriptorCollection props = _provider.Schema;
        int count = 0;
        if (props != null && props.Count > 0 && _tableData != null)
        {
          foreach (PropertyDescriptor prop in props)
          {
            foreach (DataRow o in _tableData)
            {
              writer.Write(prop.DisplayName + ": " + o[count]);
            }
            writer.WriteBreak();
            writer.WriteLine();
            count = count + 1;
          }
        }
        else
        {
          writer.Write("No data");
        }
      }
      else
      {
        writer.Write("Not connected");
      }
    }
    [ConnectionConsumer("Table")]
    public void SetConnectionInterface(IWebPartTable provider)
    {
      _provider = provider;
    }

    public class TableConsumerConnectionPoint : ConsumerConnectionPoint
    {
      public TableConsumerConnectionPoint(MethodInfo callbackMethod, Type interfaceType, Type controlType,
      string name, string id, bool allowsMultipleConnections)
        : base(
        callbackMethod, interfaceType, controlType,
        name, id, allowsMultipleConnections)
      {
      }
    }
  }
}

コード例の 2 番目の部分は、静的 Web パーツ接続でカスタムコントロールをホストする Web ページです。ページの上部には、 Register カスタムコントロールのプレフィックスと名前空間を宣言するディレクティブがあります。接続は要素を <asp:webpartconnection> 使用して宣言され、プロバイダーコントロールとコンシューマーコントロールは要素内で <asp:webpartzone> 宣言されます。

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
    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">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>IField Test Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:webpartmanager id="WebPartManager1" runat="server">
            <StaticConnections>
                <asp:WebPartConnection id="wp1" ProviderID="provider1" ConsumerID="consumer1">
                </asp:WebPartConnection>
            </StaticConnections>
        </asp:webpartmanager>
        <asp:webpartzone id="WebPartZone1" runat="server">
          <zoneTemplate>
            <aspSample:TableProviderWebPart ID="provider1" runat="server" 
              ToolTip="Web Parts Table Provider Control" />
            <aspSample:TableConsumer ID="consumer1" runat="server" 
              ToolTip="Web Parts Table Consumer Control"/>
          </zoneTemplate>
        </asp:webpartzone>
    </div>
    </form>
</body>
</html>

ブラウザーでページを読み込みます。コントロール間の接続は既に存在し、接続がページで静的接続として宣言されているため、コンシューマーはプロバイダーからのデータを表示します。

注釈

クラスのConsumerConnectionPointコンストラクターはConsumerConnectionPoint、単純に基底コンストラクターを呼び出し、それにさまざまなパラメーターを渡し、基底クラスを初期化します。

基底クラスのコンストラクターは、接続ポイントのパラメーターの数をチェックし、いくつかの例外をスローできます。可能な例外の一覧については、「例外」セクションを参照してください。

コンストラクターを ConsumerConnectionPoint 呼び出して、クラスの独自のインスタンスを ConsumerConnectionPoint 作成できます。ただし、単に接続を確立し、クラスを拡張していない場合は、メソッドを呼び出 GetConsumerConnectionPoints してプロバイダーから接続ポイントオブジェクトを返す必要があります。

適用対象

次の方法で共有

ConsumerConnectionPoint コンストラクター

定義

パラメーター

例外

例

注釈

適用対象

こちらもご覧ください

その他のリソース