ConnectionConsumerAttribute

.NET Framework クラス ライブラリ リファレンス

ConnectionConsumerAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

Web パーツ接続でコンシューマとして動作するサーバー コントロールのコールバック メソッドを識別し、コンシューマのコネクション ポイントに関する詳細を開発者が指定できるようにします。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Method)> _
Public Class ConnectionConsumerAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As ConnectionConsumerAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Method)] 
public class ConnectionConsumerAttribute :
 Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Method)] 
public ref class ConnectionConsumerAttribute
 : public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Method) */ 
public class ConnectionConsumerAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Method) 
public class ConnectionConsumerAttribute extends
 Attribute

解説

Web パーツ接続は WebPartZoneBase ゾーン内に存在する 2 つのサーバー コントロールで構成され、一方のコントロールからもう一方に渡されるインターフェイス インスタンスを使用してデータを共有します。インターフェイス インスタンスを渡すコントロールはプロバイダと呼ばれ、インターフェイス インスタンスを受け取ってデータの処理または表示を行うコントロールはコンシューマと呼ばれます。接続の詳細については、WebPartConnection クラスのトピックおよび「Web パーツ接続の概要」を参照してください。

接続のコンシューマ コントロールには WebPart コントロール、任意の種類のサーバー コントロール、ユーザー コントロールのいずれかを使用できますが、これらはコールバック メソッドとして指定されたメソッドを持っている必要があります。コールバック メソッドは接続処理を実行しているときに呼び出され、その目的はデータが格納されたインターフェイス インスタンスをプロバイダから受け取ることにあります。コンシューマでコールバック メソッドとしての役割を果たすメソッドを指定するには、ConnectionConsumerAttribute メタデータ要素をメソッドに追加する必要があります (この要素は ConnectionConsumerAttribute クラスに基づいています)。

ConnectionConsumerAttribute オブジェクトを使用すると、コンシューマのコールバック メソッドを指定することに加え、コンシューマのコネクション ポイントに関する特定の詳細を指定することもできます。コンシューマ接続ポイントは、ConsumerConnectionPoint クラスのインスタンスです。このクラスは、コンシューマのコントロールの種類、同時に複数のプロバイダに接続できるかどうか、コンシューマがプロバイダから受け取ることのできるインターフェイスの種類、コールバック メソッドに関する詳細、ユーザー インターフェイス (UI) でコンシューマ接続ポイントを表す表示名など、接続の確立に必要なコンシューマに関するすべての詳細をカプセル化します。すべての Web パーツ接続には、コンシューマ コントロールに関連付けられたコンシューマ接続ポイントが含まれます。

コンシューマのコールバック メソッドに ConnectionConsumerAttribute メタデータ要素を追加すると、それを使用してコンシューマ接続ポイントに関する詳細を指定することもできます。この詳細には、コネクション ポイントの表示名 (詳細については、DisplayName プロパティのトピックを参照)、コンシューマが同時に複数のプロバイダに接続できるかどうか (詳細については、AllowsMultipleConnections プロパティのトピックを参照)、コネクション ポイントの ID (詳細については、ID プロパティのトピックを参照)、およびコンシューマが使用するコネクション ポイントの種類 (詳細については、ConnectionPointType プロパティのトピックを参照) があります。ConnectionConsumerAttribute クラスのコンストラクタの 4 つのオーバーロードそれぞれが、クラスの新しいインスタンスを作成するときに 1 つ以上のコネクション ポイント プロパティの値を指定できるパラメータを持ちます。コンシューマ接続ポイントの大部分のプロパティはプログラムで設定することもできるため、ConnectionConsumerAttribute 要素を使用した設定方法は省略できます。

メモ

コンシューマのコールバック メソッドに ConnectionConsumerAttribute メタデータ要素を追加する場合、常に指定が必要な必須パラメータは displayName パラメータだけです (詳細については、ConnectionConsumerAttribute(String) コンストラクタ オーバーロードのトピックを参照してください)。このパラメータの値は DisplayName プロパティに割り当てられ、ConnectionsZone コントロールで作成された接続 UI を開くと、表示名がその UI でのコンシューマ接続ポイントを表します。1 つのコンシューマ コントロールに複数のコールバック メソッドを指定する場合は、複数のコネクション ポイントから選択できます。また、各コールバック メソッドに ConnectionConsumerAttribute メタデータ要素を追加する際には、それぞれのコンシューマ接続ポイントが既知で一意の ID を持つように id パラメータの値を指定する必要があります。

使用例

ConnectionConsumerAttribute クラスを使用するコード例を次に示します。ここでは、コンシューマ コントロールのコールバック メソッドで ConnectionConsumerAttribute メタデータ要素を宣言する方法を示しています。コンストラクタの最も簡単なオーバーロードを使用し、displayName パラメータ値だけを渡します。

Visual Basic

<ConnectionConsumer("Row")> _
Public Sub SetConnectionInterface(ByVal
 provider As IWebPartRow)
    _provider = provider

End Sub 'SetConnectionInterface

C#

[ConnectionConsumer("Row")]
public void SetConnectionInterface(IWebPartRow
 provider) 
{
    _provider = provider;
}

WebPartConnection クラスを使用して、2 つの Web パーツ コントロール間で基本的な静的接続を作成する方法を次のコード例に示します。プロバイダとコンシューマのコード ファイルは、.aspx ページが格納されたアプリケーション フォルダの下にある App_Code フォルダに格納する必要があります。

最初の例は、プロバイダとして動作するクラスを示します。

Visual Basic

Imports System
Imports System.Collections
Imports System.ComponentModel
Imports System.Data
Imports System.Reflection
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

'This sample code creates a Web Parts control that acts as a provider
 of row data.
Namespace MyCustomWebPart

    Public NotInheritable Class
 RowProviderWebPart
        Inherits WebPart
        Implements IWebPartRow

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

        <ConnectionProvider("Row")> _
        Public Function GetConnectionInterface()
 As IWebPartRow
            Return New RowProviderWebPart()

        End Function 'GetConnectionInterface

        Public ReadOnly Property
 Schema() As PropertyDescriptorCollection _
            Implements IWebPartRow.Schema
            Get
                Return TypeDescriptor.GetProperties(_table.DefaultView(0))
            End Get
        End Property

        Public Sub GetRowData(ByVal
 callback As RowCallback) _
            Implements IWebPartRow.GetRowData
            callback(_table.Rows)

        End Sub 'GetRowData

C#

using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Reflection;
using System.Web.UI;
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 row data.
namespace My 
{
    public sealed class RowProviderWebPart
 : WebPart, IWebPartRow 
    {

        private DataTable _table;

        public RowProviderWebPart() 
        {
            _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("Row")]
        public IWebPartRow GetConnectionInterface()
        {
            return new RowProviderWebPart();
        }
        public PropertyDescriptorCollection Schema 
        {
            get {
                return TypeDescriptor.GetProperties(_table.DefaultView[0]);
                }
        }
        public void GetRowData(RowCallback
 callback)
        {
            callback(_table.Rows);
        }
    }
}

2 番目の例は、コンシューマとして動作するクラスを示します。メソッドは、ConnectionConsumerAttribute メタデータ要素を持つコールバック メソッドとして指定されています。

Visual Basic

Imports System
Imports System.Collections
Imports System.ComponentModel
Imports System.Data
Imports System.Reflection
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

' This sample code creates a Web Parts control that acts as a consumer
 of row data.
Namespace MyCustomWebPart

    Public NotInheritable Class
 RowConsumerWebPart
        Inherits WebPart
        Private _provider As IWebPartRow
        Private _tableData As ICollection


        Private Sub GetRowData(ByVal
 rowData As Object)
            _tableData = CType(rowData, ICollection)

        End Sub 'GetRowData


        Protected Overrides Sub
 OnPreRender(ByVal e As EventArgs)
            If Not (_provider Is
 Nothing) Then
                '        _provider.GetRowData(AddressOf (New RowCallback(GetRowData)))
                _provider.GetRowData(AddressOf GetRowData)
                '    _provider.GetRowData(New RowCallback(AddressOf
 GetRowData))
            End If

        End Sub 'OnPreRender



        Protected Overrides Sub
 RenderContents(ByVal writer As HtmlTextWriter)
            If Not (_provider Is
 Nothing) Then
                Dim props As PropertyDescriptorCollection
 = _provider.Schema
                Dim count As Integer
 = 0
                If Not (props Is
 Nothing) AndAlso props.Count > 0 AndAlso
 Not (_tableData Is Nothing) Then
                    Dim prop As PropertyDescriptor
                    For Each prop In
 props
                        Dim o As DataRow
                        For Each o In
 _tableData
                            writer.Write(prop.DisplayName & ":
 " & o(count))
                            writer.WriteBreak()
                            writer.WriteLine()
                            count = count + 1
                        Next o
                    Next prop
                Else
                    writer.Write("No data")
                End If
            Else
                writer.Write("Not connected")
            End If

        End Sub 'RenderContents

        <ConnectionConsumer("Row")> _
        Public Sub SetConnectionInterface(ByVal
 provider As IWebPartRow)
            _provider = provider

        End Sub 'SetConnectionInterface

    '}

C#

using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Reflection;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
// This sample code creates a Web Parts control that acts as a consumer
 of row data.
namespace My 
{

    public sealed class RowConsumerWebPart
 : WebPart {
        private IWebPartRow _provider;
        private ICollection _tableData;
    
            private void GetRowData(object
 rowData)
            {
                _tableData = (ICollection)rowData;
            }

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


        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("Row")]
        public void SetConnectionInterface(IWebPartRow
 provider) 
        {
            _provider = provider;
        }
         }
    
    }
//}

最後の例は、2 つのコントロールが含まれた ASP.NET ページを示します。

Visual Basic

<%@ page language="VB" %>
<%@ Register TagPrefix=my Namespace=MyCustomWebPart %>

<html>
<head runat="server">
    <title>IRow Test Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <!-- A static or dynamic connection
 is required to link two Web Parts controls.
 --->
        <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>
                <my:RowProviderWebPart ID=provider1 runat=server Title="Row
 Provider Control" />
                <my:RowConsumerWebPart ID=consumer1 runat=server Title="Row
 Consumer Control" />
           </ZoneTemplate>
        </asp:webpartzone>
    </div>
    </form>
</body>
</html>

C#

<%@ page language="C#" %>
<%@ register TagPrefix="my" Namespace="My" %>

<html>
<head runat="server">
    <title>IRow Test Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <!-- A static or dynamic connection is required to
 link two Web Parts controls. --->
        <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>
                <!-- The following two lines specify the two connected controls.
 --->
                <my:RowProviderWebPart ID=provider1 runat=server Title="Row
 Provider Control" />
                <my:RowConsumerWebPart ID=consumer1 runat=server Title="Row
 Consumer Control" />
            </ZoneTemplate>
        </asp:webpartzone>
    </div>
    </form>
</body>
</html>

.NET Framework のセキュリティ

• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.Attribute
    System.Web.UI.WebControls.WebParts.ConnectionConsumerAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConnectionConsumerAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間
WebPartConnection
ConnectionPoint
ConsumerConnectionPoint
ConnectionProviderAttribute
その他の技術情報
ASP.NET Web パーツ ページ
Web パーツ ページの保護
Web パーツ接続の概要

ConnectionConsumerAttribute コンストラクタ (String, Type)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

表示名およびコンシューマ接続ポイントに使用する特定の種類のコネクション ポイント オブジェクトを指定して、ConnectionConsumerAttribute クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    displayName As String, _
    connectionPointType As Type _
)

Visual Basic (使用法)

Dim displayName As String
Dim connectionPointType As Type

Dim instance As New ConnectionConsumerAttribute(displayName,
 connectionPointType)

C#

public ConnectionConsumerAttribute (
    string displayName,
    Type connectionPointType
)

C++

public:
ConnectionConsumerAttribute (
    String^ displayName, 
    Type^ connectionPointType
)

J#

public ConnectionConsumerAttribute (
    String displayName, 
    Type connectionPointType
)

JScript

public function ConnectionConsumerAttribute
 (
    displayName : String, 
    connectionPointType : Type
)

パラメータ

displayName

ユーザー インターフェイス (UI) に表示する、コンシューマ接続ポイントの表示名が含まれている文字列。

connectionPointType

ConsumerConnectionPoint から派生し、特定のコールバック メソッドで使用するコネクション ポイント オブジェクトの種類として指定する Type。

例外

例外の種類	条件
ArgumentNullException	displayName または connectionPointType が null 参照 (Visual Basic では Nothing) です。
ArgumentException	connectionPointType が有効ではありません。

解説

displayName パラメータは、UI でコンシューマのコネクション ポイントを表すために ConnectionsZone コントロールによって使用される、コンシューマ接続ポイントの表示名です。

connectionPointType パラメータは、ConsumerConnectionPoint から派生した Type にする必要があります。このパラメータが指定されている場合、Web パーツ コントロール セットで提供される標準の ConsumerConnectionPoint クラスの代わりに、Type を使用してコネクション ポイントが作成されます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConnectionConsumerAttribute クラス
ConnectionConsumerAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間
ConnectionPointType
DisplayName

ConnectionConsumerAttribute コンストラクタ (String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

コンシューマ接続ポイントの表示名を指定して、ConnectionConsumerAttribute クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    displayName As String _
)

Visual Basic (使用法)

Dim displayName As String

Dim instance As New ConnectionConsumerAttribute(displayName)

C#

public ConnectionConsumerAttribute (
    string displayName
)

C++

public:
ConnectionConsumerAttribute (
    String^ displayName
)

J#

public ConnectionConsumerAttribute (
    String displayName
)

JScript

public function ConnectionConsumerAttribute
 (
    displayName : String
)

パラメータ

displayName

ユーザー インターフェイス (UI) に表示する、コンシューマ接続ポイントの表示名が含まれている文字列。

例外

例外の種類	条件
ArgumentNullException	displayName が null 参照 (Visual Basic では Nothing) です。

解説

このコンストラクタは、コンシューマとして機能する Web パーツ コントロールのメソッドで使用される属性のインスタンスを作成します。このメソッドは、プロバイダとコンシューマ間のコネクション ポイントになります。通常、このコンストラクタを使用する場合、コンシューマ コントロールのコールバック メソッドとして指定するメソッドで ConnectionConsumerAttribute メタデータ要素を宣言します。

displayName パラメータは、UI でコンシューマのコネクション ポイントを表すために ConnectionsZone コントロールによって使用される、コンシューマ接続ポイントの表示名です。

使用例

ConnectionConsumerAttribute クラスを使用するコード例を次に示します。ここでは、コンシューマ コントロールのコールバック メソッドで ConnectionConsumerAttribute メタデータ要素を宣言する方法を示しています。コンストラクタの最も簡単なオーバーロードを使用し、displayName パラメータ値だけを渡します。このコード例の実行に必要なコード全体については、ConnectionConsumerAttribute クラスの概要を参照してください。

Visual Basic

<ConnectionConsumer("Row")> _
Public Sub SetConnectionInterface(ByVal
 provider As IWebPartRow)
    _provider = provider

End Sub 'SetConnectionInterface

C#

[ConnectionConsumer("Row")]
public void SetConnectionInterface(IWebPartRow
 provider) 
{
    _provider = provider;
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConnectionConsumerAttribute クラス
ConnectionConsumerAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間
DisplayName

ConnectionConsumerAttribute コンストラクタ (String, String, Type)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

表示名、ID、およびコンシューマ接続ポイントに使用する特定の種類のコネクション ポイント オブジェクトを指定して、ConnectionConsumerAttribute クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    displayName As String, _
    id As String, _
    connectionPointType As Type _
)

Visual Basic (使用法)

Dim displayName As String
Dim id As String
Dim connectionPointType As Type

Dim instance As New ConnectionConsumerAttribute(displayName,
 id, connectionPointType)

C#

public ConnectionConsumerAttribute (
    string displayName,
    string id,
    Type connectionPointType
)

C++

public:
ConnectionConsumerAttribute (
    String^ displayName, 
    String^ id, 
    Type^ connectionPointType
)

J#

public ConnectionConsumerAttribute (
    String displayName, 
    String id, 
    Type connectionPointType
)

JScript

public function ConnectionConsumerAttribute
 (
    displayName : String, 
    id : String, 
    connectionPointType : Type
)

パラメータ

displayName

ユーザー インターフェイス (UI) に表示する、コンシューマ接続ポイントの表示名が含まれている文字列。

id

コンシューマ接続ポイントに割り当てられている一意な文字列値の ID。

connectionPointType

ConsumerConnectionPoint から派生し、特定のコールバック メソッドで使用するコネクション ポイント オブジェクトの種類として指定する Type。

例外

例外の種類	条件
ArgumentNullException	displayName、id、または connectionPointType が null 参照 (Visual Basic では Nothing) です。
ArgumentException	connectionPointType が有効ではありません。

解説

displayName パラメータは、UI でコンシューマのコネクション ポイントを表すために ConnectionsZone コントロールによって使用される、コンシューマ接続ポイントの表示名です。

id パラメータは、特定のコールバック メソッドに関連付けられたコンシューマ接続ポイントの ID を指定するために使用します。1 つのコントロールで複数のコネクション ポイントを持つことができますが、それぞれの id を一意にする必要があります。そのため、コンシューマ コントロールで複数のコールバック メソッドを使用する場合に、コンストラクタのこのオーバーロードが役に立ちます。

connectionPointType パラメータは、ConsumerConnectionPoint から派生した Type にする必要があります。このパラメータが指定されている場合、Web パーツ コントロール セットで提供される標準の ConsumerConnectionPoint クラスの代わりに、Type を使用してコネクション ポイントが作成されます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConnectionConsumerAttribute クラス
ConnectionConsumerAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間
ConnectionPointType
DisplayName
ID

ConnectionConsumerAttribute コンストラクタ

ConnectionConsumerAttribute クラスの新しいインスタンスを初期化し、コネクション ポイントの表示名に使用する値を指定して、オプションでコネクション ポイントの ID またはコネクション ポイントの種類 (またはその両方) に使用する値を指定します。

コンシューマ コントロールは、ConnectionConsumerAttribute メタデータ要素でマークされた複数のメソッドを持つことができます。この場合、コンシューマが複数のコネクション ポイントを持つため、コンシューマのコネクション ポイントを識別できるように、ConnectionConsumerAttribute 要素のそれぞれのインスタンスで関連するコネクション ポイントに対して一意の ID を指定する必要があります。

オーバーロードの一覧

名前	説明
ConnectionConsumerAttribute (String)	コンシューマ接続ポイントの表示名を指定して、ConnectionConsumerAttribute クラスの新しいインスタンスを初期化します。
ConnectionConsumerAttribute (String, String)	コンシューマ接続ポイントの表示名と ID を指定して、ConnectionConsumerAttribute クラスの新しいインスタンスを初期化します。
ConnectionConsumerAttribute (String, Type)	表示名およびコンシューマ接続ポイントに使用する特定の種類のコネクション ポイント オブジェクトを指定して、ConnectionConsumerAttribute クラスの新しいインスタンスを初期化します。
ConnectionConsumerAttribute (String, String, Type)	表示名、ID、およびコンシューマ接続ポイントに使用する特定の種類のコネクション ポイント オブジェクトを指定して、ConnectionConsumerAttribute クラスの新しいインスタンスを初期化します。

参照

関連項目

ConnectionConsumerAttribute クラス
ConnectionConsumerAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間
DisplayName

ConnectionConsumerAttribute コンストラクタ (String, String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

コンシューマ接続ポイントの表示名と ID を指定して、ConnectionConsumerAttribute クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    displayName As String, _
    id As String _
)

Visual Basic (使用法)

Dim displayName As String
Dim id As String

Dim instance As New ConnectionConsumerAttribute(displayName,
 id)

C#

public ConnectionConsumerAttribute (
    string displayName,
    string id
)

C++

public:
ConnectionConsumerAttribute (
    String^ displayName, 
    String^ id
)

J#

public ConnectionConsumerAttribute (
    String displayName, 
    String id
)

JScript

public function ConnectionConsumerAttribute
 (
    displayName : String, 
    id : String
)

パラメータ

displayName

ユーザー インターフェイス (UI) に表示する、コンシューマ接続ポイントの表示名が含まれている文字列。

id

コンシューマ接続ポイントに割り当てられている一意な文字列値の ID。

例外

例外の種類	条件
ArgumentNullException	displayName または id が null 参照 (Visual Basic では Nothing) です。

解説

displayName パラメータは、UI でコンシューマのコネクション ポイントを表すために ConnectionsZone コントロールによって使用される、コンシューマ接続ポイントの表示名です。

id パラメータは、特定のコールバック メソッドに関連付けられたコンシューマ接続ポイントの ID を指定するために使用します。1 つのコントロールで複数のコネクション ポイントを持つことができますが、それぞれの id を一意にする必要があります。そのため、コンシューマ コントロールで複数のコールバック メソッドを使用する場合に、コンストラクタのこのオーバーロードが役に立ちます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConnectionConsumerAttribute クラス
ConnectionConsumerAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間
DisplayName
ID

ConnectionConsumerAttribute プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	AllowsMultipleConnections	コネクション ポイントで複数の接続が許可されるかどうかを示す値を取得または設定します。
	ConnectionPointType	コンシューマ接続ポイントのコネクション ポイントの種類を取得します。
	DisplayName	コンシューマ接続ポイントの表示名を取得します。
	ID	コンシューマ接続ポイントの一意の ID を表す文字列を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

プロテクト プロパティ

	名前	説明
	DisplayNameValue	ローカリゼーションで使用するために、DisplayName プロパティの値として使用する文字列を取得または設定します。

参照

関連項目

ConnectionConsumerAttribute クラス
System.Web.UI.WebControls.WebParts 名前空間
WebPartConnection
ConnectionPoint
ConsumerConnectionPoint
ConnectionProviderAttribute

その他の技術情報

ASP.NET Web パーツ ページ
Web パーツ ページの保護
Web パーツ接続の概要

ConnectionConsumerAttribute メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 ( Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

ConnectionConsumerAttribute クラス
System.Web.UI.WebControls.WebParts 名前空間
WebPartConnection
ConnectionPoint
ConsumerConnectionPoint
ConnectionProviderAttribute

その他の技術情報

ASP.NET Web パーツ ページ
Web パーツ ページの保護
Web パーツ接続の概要

ConnectionConsumerAttribute メンバ

Web パーツ接続でコンシューマとして動作するサーバー コントロールのコールバック メソッドを識別し、コンシューマのコネクション ポイントに関する詳細を開発者が指定できるようにします。

ConnectionConsumerAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	ConnectionConsumerAttribute	オーバーロードされます。 ConnectionConsumerAttribute クラスの新しいインスタンスを初期化し、コネクション ポイントの表示名に使用する値を指定して、オプションでコネクション ポイントの ID またはコネクション ポイントの種類 (またはその両方) に使用する値を指定します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	AllowsMultipleConnections	コネクション ポイントで複数の接続が許可されるかどうかを示す値を取得または設定します。
	ConnectionPointType	コンシューマ接続ポイントのコネクション ポイントの種類を取得します。
	DisplayName	コンシューマ接続ポイントの表示名を取得します。
	ID	コンシューマ接続ポイントの一意の ID を表す文字列を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

プロテクト プロパティ

	名前	説明
	DisplayNameValue	ローカリゼーションで使用するために、DisplayName プロパティの値として使用する文字列を取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 (Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

ConnectionConsumerAttribute クラス
System.Web.UI.WebControls.WebParts 名前空間
WebPartConnection
ConnectionPoint
ConsumerConnectionPoint
ConnectionProviderAttribute

その他の技術情報

ASP.NET Web パーツ ページ
Web パーツ ページの保護
Web パーツ接続の概要