ConnectionConsumerAttribute.DisplayName プロパティ

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

ConnectionConsumerAttribute.DisplayName プロパティ

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

コンシューマ接続ポイントの表示名を取得します。

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

Visual Basic (宣言)

Public Overridable ReadOnly
 Property DisplayName As String

Visual Basic (使用法)

Dim instance As ConnectionConsumerAttribute
Dim value As String

value = instance.DisplayName

C#

public virtual string DisplayName { get;
 }

C++

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

J#

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

JScript

public function get DisplayName
 () : String

プロパティ値
コンシューマ接続ポイントの表示名を含む文字列。

解説

このプロパティは、コンシューマ接続ポイントの表示名です。コールバック メソッドの ConnectionConsumerAttribute メタデータ要素に displayName パラメータを追加するときに、この値を宣言して設定できます。また、保護された DisplayNameValue プロパティを使用して、派生クラスによってプログラムで設定することもできます。

ID プロパティは一意にする必要がありますが、DisplayName プロパティを一意にする必要はないため、コネクション ポイントのコレクション内を検索する場合は、ID プロパティを使用する必要があります。

ページ上に ConnectionsZone コントロールがあるとき、接続ユーザー インターフェイス (UI) が開いているとき、およびユーザーが接続を確立するためにコネクション ポイントを選択できるページを表示しているときに、コンシューマ接続ポイントの DisplayName プロパティが表示されます。

使用例

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