ConnectionPoint.DisplayName プロパティ

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

ConnectionPoint.DisplayName プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

ユーザー インターフェイス (UI) でコネクション ポイントを表す表示名として使用される文字列を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 DisplayName As String

Visual Basic (使用法)

Dim instance As ConnectionPoint
Dim value As String

value = instance.DisplayName

C#

public string DisplayName { get;
 }

C++

public:
property String^ DisplayName {
    String^ get ();
}

J#

/** @property */
public String get_DisplayName ()

JScript

public function get DisplayName
 () : String

プロパティ値
ConnectionPoint オブジェクトの表示名を含む文字列。

解説

Web パーツ接続を作成するには、接続のプロバイダ コントロールとコンシューマ コントロールが、それぞれ少なくとも 1 つのコネクション ポイントを指定している必要があります。コネクション ポイントは、プロバイダ コントロールとコンシューマ コントロールの間の通信とデータの共有を可能にするメソッドです。これらのコネクション ポイント メソッドを識別するために、開発者は選択したメソッドで属性を指定します。プロバイダ コントロールでは、選択されたコールバック メソッドに ConnectionProvider 属性が設定され、コンシューマ コントロールでは、プロバイダからのデータを格納するインターフェイスのインスタンスを受け取るメソッドに ConnectionConsumer 属性が設定されます。これらの属性には、属性を作成するためにどのオーバーロードが宣言されているかには関係なく、常に必須のパラメータが 1 つあります。それは、displayName パラメータです。開発者はコネクション ポイントの表示名として使用される文字列を割り当てる必要があります。この文字列は、DisplayName プロパティの値となります。

DisplayName プロパティ値は、ユーザーが接続を作成するときに、Web ページの UI に表示されます。たとえば、ConnectionsZone コントロールがページに追加されると、ユーザーがコントロール間の接続を作成するための UI が作成されます。ユーザーがページを接続表示モードに切り替えた後で WebPart コントロールの Connect 動詞をクリックすると、接続 UI が表示されます。接続に参加できる各コントロールが UI に一覧表示され、各コントロールが使用できるコネクション ポイントの表示名を示すドロップダウン リスト コントロールが各コントロールの横に表示されます。接続を確立するために、ユーザーは、少なくとも 1 つのコネクション ポイントを選択する必要があります。コネクション ポイントのリストに表示される値は、DisplayName プロパティから取得されます。開発者が接続を作成するためのカスタム UI を作成する場合も、同様の方法で DisplayName プロパティを使用して、コネクション ポイントを表す表示名を提供できます。

プラットフォーム

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

参照

関連項目
ConnectionPoint クラス
ConnectionPoint メンバ
System.Web.UI.WebControls.WebParts 名前空間
ConnectionProviderAttribute
ConnectionConsumerAttribute クラス
その他の技術情報
ASP.NET Web パーツ ページ