WebPart.Description プロパティ

定義

パーツ コントロールのツールヒントやカタログで使用する、パーツ コントロールの動作をまとめた短い語句を取得または設定します。

public:
 virtual property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public override string Description { get; set; }
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.Description : string with get, set
Public Overrides Property Description As String

プロパティ値

パーツ コントロールの機能を簡潔にまとめた文字列。 既定値は空の文字列 ("") です。

実装

属性

注釈

プロパティは Description 通常、パーツ コントロールのリストを提供するカタログで使用される文字列であり、パーツ コントロールのタイトル バーのツールヒントとして使用されます。 パーツ コントロールの Description タイトル バーのタイトル テキストの上にマウス ポインターを置くと、プロパティの内容がツールヒントに表示されます。 ツールヒント テキストは、プロパティの値から作成され、その後に DisplayTitle ハイフンが続き、その後にプロパティ値が Description 続きます。

このプロパティを使用するコード例については、基本 Description プロパティを参照してください。

このプロパティのパーソナル化スコープは に Shared 設定され、承認されたユーザーのみが変更できます。 詳細については、「および Web パーツのパーソナル化の概要」を参照してくださいPersonalizableAttribute

適用対象

こちらもご覧ください