ConnectionConsumerAttribute.DisplayName プロパティ

定義

名前空間:

System.Web.UI.WebControls.WebParts

アセンブリ:

System.Web.dll

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

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

public virtual string DisplayName { get; }

member this.DisplayName : string

Public Overridable ReadOnly Property DisplayName As String

プロパティ値

String

コンシューマー接続ポイントの表示名を含む文字列。

例

次のコード例では、 プロパティを DisplayName 使用して、コンシューマー コントロールの ConnectionConsumerAttribute コールバック メソッドでメタデータ要素を宣言する方法を示します。 コンストラクターの最も単純なオーバーロードが使用されることに注意してください。 displayName パラメーター値のみが指定されます。 パラメーターの値は、 プロパティの DisplayName 値になります。 コード例を実行するために必要な完全なコードについては、クラスの概要に関するページを ConnectionConsumerAttribute 参照してください。

[ConnectionConsumer("Row")]
public void SetConnectionInterface(IWebPartRow provider) 
{
    _provider = provider;
}

    <ConnectionConsumer("Row")> _
    Public Sub SetConnectionInterface(ByVal provider As IWebPartRow)
        _provider = provider

    End Sub
End Class

注釈

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

接続ポイント コレクションを検索する場合は、 プロパティを使用する ID 必要があります。ID プロパティは一意である必要がありますが DisplayName 、 プロパティはである必要はありません。

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

こちらもご覧ください

• DisplayName
• DisplayNameValue