ConnectionProviderAttribute.DisplayName プロパティ

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

ConnectionProviderAttribute.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 ConnectionProviderAttribute
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

プロパティ値
プロバイダ コネクション ポイントの表示名を含む文字列。

解説

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

コネクション ポイントのコレクション内で検索を行う場合は、ID プロパティを使用する必要があります。これは、ID プロパティが必ず一意であるのに対して、DisplayName プロパティは必ずしも一意ではないからです。

プロバイダ コネクション ポイントの DisplayName プロパティは、ページ上に ConnectionsZone コントロールがあり、接続ユーザー インターフェイス (UI) が開かれていて、かつ、ユーザーが接続を確立するためのコネクション ポイントを選択できるビューを使用している場合に、ユーザーに対して表示されます。

使用例

DisplayName プロパティを使用するコード例を次に示します。この例では、プロバイダ コントロールのコールバック メソッドで ConnectionProviderAttribute メタデータ要素を宣言する方法を示しています。displayName パラメータ値だけが指定された、最も簡単なコンストラクタのオーバーロードが使用されています。このパラメータの値が、DisplayName プロパティの値になります。この例の実行に必要なコード全体については、ConnectionProviderAttribute クラスの概要を参照してください。

Visual Basic

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

End Function 'GetConnectionInterface

C#

[ConnectionProvider("Row")]
public IWebPartRow GetConnectionInterface()
{
    return new RowProviderWebPart();
}

プラットフォーム

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

参照

関連項目
ConnectionProviderAttribute クラス
ConnectionProviderAttribute メンバ
System.Web.UI.WebControls.WebParts 名前空間
ConnectionPoint.DisplayName プロパティ
DisplayNameValue