ConnectionPoint.DisplayName プロパティ

定義

名前空間:

System.Web.UI.WebControls.WebParts

アセンブリ:

System.Web.dll

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

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

public string DisplayName { get; }

member this.DisplayName : string

Public ReadOnly Property DisplayName As String

プロパティ値

String

ConnectionPoint オブジェクトの表示名を含む文字列。

注釈

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

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

こちらもご覧ください

• ConnectionProviderAttribute
• ConnectionConsumerAttribute
• ASP.NET Web パーツ コントロール