WebPartDescription プロパティ

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

WebPartDescription プロパティ

パブリック プロパティ

	名前	説明
	CatalogIconImageUrl	WebPart コントロールのアイコンとして使用されるイメージへのパスを含む URL を取得します。
	Description	WebPart コントロールの説明のテキストを取得します。
	ID	対応する WebPart コントロールの ID を取得します。
	Title	対応する WebPart コントロールのタイトルのテキストを取得します。

参照

関連項目

WebPartDescription クラス
System.Web.UI.WebControls.WebParts 名前空間
GetAvailableWebPartDescriptions
WebPartDescriptionCollection

その他の技術情報

ASP.NET Web パーツ ページ

WebPart.Description プロパティ

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

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

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

Visual Basic (宣言)

Public Overrides Property
 Description As String

Visual Basic (使用法)

Dim instance As WebPart
Dim value As String

value = instance.Description

instance.Description = value

C#

public override string Description { get;
 set; }

C++

public:
virtual property String^ Description {
    String^ get () override;
    void set (String^ value) override;
}

J#

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

/** @property */
public void set_Description (String value)

JScript

public override function get
 Description () : String

public override function set
 Description (value : String)

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

解説

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

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

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

プラットフォーム

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

参照

関連項目
WebPart クラス
WebPart メンバ
System.Web.UI.WebControls.WebParts 名前空間
Part.Description プロパティ
その他の技術情報
ASP.NET Web パーツ ページ