WebPartConnectionsEventArgsとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

WebPartConnectionsEventArgs クラス

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

WebPartManager コントロールの WebPartsConnected イベントおよび WebPartsDisconnected イベントのイベントデータを提供します。

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

Visual Basic (宣言)

Public Class WebPartConnectionsEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As WebPartConnectionsEventArgs

public class WebPartConnectionsEventArgs :
 EventArgs

C++

public ref class WebPartConnectionsEventArgs
 : public EventArgs

public class WebPartConnectionsEventArgs extends
 EventArgs

JScript

public class WebPartConnectionsEventArgs extends
 EventArgs

解説

Web パーツコントロールセットの機能を使用して、2 つの WebPart または他のサーバーコントロールの間の接続を作成し、1 つのコントロールはプロバイダとして機能させ、もう 1 つのコントロールをデータのコンシューマとして機能させることができます。接続を形成するには、2 つのコントロールが WebPartZoneBase クラスから継承するゾーンに配置され (WebPartZone コントロールなど)、共通のインターフェイスを通じてデータを共有できるように正しく設計されている必要があります。Web パーツ接続の詳細については、「WebPartConnection」および「Web パーツ接続の概要」を参照してください。

WebPartConnectionsEventArgs クラスは、イベントを処理する WebPartConnectionsEventHandler デリゲートを使用するメソッドにイベントデータを渡します。イベントを発生させ、WebPartConnectionsEventArgs クラスを使用してイベントデータを提供するこのような接続関連のメソッドは 2 つあります。これらはいずれも、WebPartManager コントロールのメンバです。OnWebPartsConnected メソッドは 2 つのサーバーコントロールが正常に接続された後で WebPartsConnected イベントを発生させ、OnWebPartsDisconnected メソッドは 2 つのサーバーコントロールの接続が切断された後で WebPartsDisconnected イベントを発生させます。

開発者は、WebPartsConnected イベントと WebPartsDisconnected イベントのカスタムイベントハンドラを作成でき、それらのメソッド内で、接続の詳細にアクセスするための WebPartConnectionsEventArgs クラスを使用できます。たとえば、<asp:webpartmanager> 要素で OnWebPartsConnected 属性を宣言し、イベントを処理するカスタムメソッド名にそれを割り当てることができます。カスタムハンドラメソッドでは、パラメータとしてメソッドに渡される WebPartConnectionsEventArgs オブジェクトを使用して、接続の詳細にアクセスできます。

WebPartConnectionsEventArgs クラスには、コンストラクタの 2 つのオーバーロードがあります。System.Web.UI.WebControls.WebParts.WebPartConnectionsEventArgs(WebPart,ProviderConnectionPoint,WebPart,ConsumerConnectionPoint) コンストラクタは既定で、クラスのプロパティ値を初期化します。System.Web.UI.WebControls.WebParts.WebPartConnectionsEventArgs(WebPart,ProviderConnectionPoint,WebPart,ConsumerConnectionPoint,WebPartConnection) コンストラクタは既定のコンストラクタを呼び出し、Connection プロパティの初期化も行います。

WebPartConnectionsEventArgs クラスにはいくつかのプロパティがあり、それらはすべて、Web パーツ接続に不可欠な要素を参照します。Connection プロパティは、接続全体を表す、関連付けられた WebPartConnection オブジェクトを参照します。Provider プロパティは接続でプロバイダとして機能する WebPart またはその他のコントロールを参照し、Consumer プロパティはコンシューマとして機能する WebPart またはサーバーコントロールを参照します。ProviderConnectionPoint プロパティは接続の ProviderConnectionPoint オブジェクトを参照し、ConsumerConnectionPoint プロパティは ConsumerConnectionPoint オブジェクトを参照します。

.NET Framework のセキュリティ

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

継承階層

System.Object
System.EventArgs
System.Web.UI.WebControls.WebParts.WebPartConnectionsEventArgs

スレッドセーフ

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

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebPartConnectionsEventArgs メンバ
System.Web.UI.WebControls.WebParts 名前空間
WebPartConnectionsEventHandler
WebPartsConnected
WebPartsDisconnected
OnWebPartsConnected
OnWebPartsDisconnected
その他の技術情報
ASP.NET Web パーツページ
Web パーツ接続の概要

WebPartConnectionsEventArgs コンストラクタ (WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)

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

WebPartConnection オブジェクトを必要とせずに、WebPartConnectionsEventArgs クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    provider As WebPart, _
    providerConnectionPoint As ProviderConnectionPoint, _
    consumer As WebPart, _
    consumerConnectionPoint As ConsumerConnectionPoint _
)

Visual Basic (使用法)

Dim provider As WebPart
Dim providerConnectionPoint As ProviderConnectionPoint
Dim consumer As WebPart
Dim consumerConnectionPoint As ConsumerConnectionPoint

Dim instance As New WebPartConnectionsEventArgs(provider,
 providerConnectionPoint, consumer, consumerConnectionPoint)

public WebPartConnectionsEventArgs (
    WebPart provider,
    ProviderConnectionPoint providerConnectionPoint,
    WebPart consumer,
    ConsumerConnectionPoint consumerConnectionPoint
)

C++

public:
WebPartConnectionsEventArgs (
    WebPart^ provider, 
    ProviderConnectionPoint^ providerConnectionPoint, 
    WebPart^ consumer, 
    ConsumerConnectionPoint^ consumerConnectionPoint
)

public WebPartConnectionsEventArgs (
    WebPart provider, 
    ProviderConnectionPoint providerConnectionPoint, 
    WebPart consumer, 
    ConsumerConnectionPoint consumerConnectionPoint
)

JScript

public function WebPartConnectionsEventArgs
 (
    provider : WebPart, 
    providerConnectionPoint : ProviderConnectionPoint, 
    consumer : WebPart, 
    consumerConnectionPoint : ConsumerConnectionPoint
)

パラメータ

provider: プロバイダとして機能するコントロール。

providerConnectionPoint: プロバイダコネクションポイント。

consumer: コンシューマとして機能するコントロール。

consumerConnectionPoint: コンシューマ接続ポイント。

解説

これは、既定のコンストラクタです。WebPartConnection オブジェクトは必要としません。このコンストラクタは、その接続関連のパラメータオブジェクトを対応するプロパティにそれぞれ割り当てることにより、そのプロパティの値を初期化します。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

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

WebPartConnectionsEventArgs コンストラクタ (WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartConnection)

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

WebPartConnection オブジェクトを指定して、クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    provider As WebPart, _
    providerConnectionPoint As ProviderConnectionPoint, _
    consumer As WebPart, _
    consumerConnectionPoint As ConsumerConnectionPoint, _
    connection As WebPartConnection _
)

Visual Basic (使用法)

Dim provider As WebPart
Dim providerConnectionPoint As ProviderConnectionPoint
Dim consumer As WebPart
Dim consumerConnectionPoint As ConsumerConnectionPoint
Dim connection As WebPartConnection

Dim instance As New WebPartConnectionsEventArgs(provider,
 providerConnectionPoint, consumer, consumerConnectionPoint, connection)

public WebPartConnectionsEventArgs (
    WebPart provider,
    ProviderConnectionPoint providerConnectionPoint,
    WebPart consumer,
    ConsumerConnectionPoint consumerConnectionPoint,
    WebPartConnection connection
)

C++

public:
WebPartConnectionsEventArgs (
    WebPart^ provider, 
    ProviderConnectionPoint^ providerConnectionPoint, 
    WebPart^ consumer, 
    ConsumerConnectionPoint^ consumerConnectionPoint, 
    WebPartConnection^ connection
)

public WebPartConnectionsEventArgs (
    WebPart provider, 
    ProviderConnectionPoint providerConnectionPoint, 
    WebPart consumer, 
    ConsumerConnectionPoint consumerConnectionPoint, 
    WebPartConnection connection
)

JScript

public function WebPartConnectionsEventArgs
 (
    provider : WebPart, 
    providerConnectionPoint : ProviderConnectionPoint, 
    consumer : WebPart, 
    consumerConnectionPoint : ConsumerConnectionPoint, 
    connection : WebPartConnection
)

パラメータ

provider: プロバイダとして機能する WebPart またはサーバーコントロール。

providerConnectionPoint: 接続の ProviderConnectionPoint。

consumer: コンシューマとして機能する WebPart またはサーバーコントロール。

consumerConnectionPoint: 接続の ConsumerConnectionPoint。

connection: WebPartConnection オブジェクト。

解説

WebPartConnectionsEventArgs コンストラクタのこのバージョンは、WebPartConnection オブジェクトを使用できる場合に使用されます。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

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

WebPartConnectionsEventArgs コンストラクタ

WebPartConnectionsEventArgs クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
WebPartConnectionsEventArgs (WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)	WebPartConnection オブジェクトを必要とせずに、WebPartConnectionsEventArgs クラスの新しいインスタンスを初期化します。
WebPartConnectionsEventArgs (WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartConnection)	WebPartConnection オブジェクトを指定して、クラスの新しいインスタンスを初期化します。

参照

WebPartConnectionsEventArgs プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	Connection	現在の接続の WebPartConnection オブジェクトを取得します。
	Consumer	接続でコンシューマとして機能する WebPart コントロールを取得します。
	ConsumerConnectionPoint	現在の接続の ConsumerConnectionPoint オブジェクトを取得します。
	Provider	接続でプロバイダとして機能する WebPart コントロールを取得します。
	ProviderConnectionPoint	現在の接続の ProviderConnectionPoint オブジェクトを取得します。

参照

その他の技術情報

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

WebPartConnectionsEventArgs メソッド

パブリックメソッドパブリックメソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

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

参照

その他の技術情報

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

WebPartConnectionsEventArgs メンバ

WebPartManager コントロールの WebPartsConnected イベントおよび WebPartsDisconnected イベントのイベントデータを提供します。

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

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

	名前	説明
	WebPartConnectionsEventArgs	オーバーロードされます。 WebPartConnectionsEventArgs クラスの新しいインスタンスを初期化します。

パブリックプロパティ

	名前	説明
	Connection	現在の接続の WebPartConnection オブジェクトを取得します。
	Consumer	接続でコンシューマとして機能する WebPart コントロールを取得します。
	ConsumerConnectionPoint	現在の接続の ConsumerConnectionPoint オブジェクトを取得します。
	Provider	接続でプロバイダとして機能する WebPart コントロールを取得します。
	ProviderConnectionPoint	現在の接続の ProviderConnectionPoint オブジェクトを取得します。

パブリックメソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

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