WebPartDescription.Description プロパティ

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

WebPartDescription.Description プロパティ

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

WebPart コントロールの説明のテキストを取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 Description As String

Visual Basic (使用法)

Dim instance As WebPartDescription
Dim value As String

value = instance.Description

C#

public string Description { get;
 }

C++

public:
property String^ Description {
    String^ get ();
}

J#

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

JScript

public function get Description
 () : String

プロパティ値
WebPart コントロールの説明を含む文字列。既定値は空の文字列 ("") です。

解説

Description プロパティは、Part.Description プロパティに直接対応します。そのプロパティが WebPart コントロールに設定される場合、対応する WebPartDescription オブジェクトのプロパティも値を持ちます。

Description プロパティは、ページがカタログ表示モードである場合のみ適用され、コントロールのカタログに WebPart コントロールが表示されます。コントロールに説明が割り当てられている場合、その説明は、コントロールのツールヒントとしてカタログに表示されます。

使用例

Description プロパティのプログラムでの使用方法を示すコード例を次に示します。このコード例の実行に必要なコード全体については、WebPartDescription クラスの概要のトピックで「例」を参照してください。

Web ページの Button1_Click メソッド内にある次のコードは、カタログ内のWebPartDescription オブジェクトのコレクションを GetAvailableWebPartDescriptions メソッドを使用して取得する方法と、カタログ内の各 WebPart コントロールの詳細を WebPartDescription オブジェクトをループして表示する方法を示します。Description プロパティ値は次のコードで取得されます。

Visual Basic

Protected Sub Button1_Click(ByVal
 sender As Object, _
  ByVal e As System.EventArgs)
  
  Label1.Text = String.Empty
      
  Dim descriptions As WebPartDescriptionCollection
 = _
   DeclarativeCatalogPart1.GetAvailableWebPartDescriptions()
          
  Dim desc As WebPartDescription
      
  For Each desc In descriptions
    Label1.Text += "ID: " & desc.ID & "<br
 />" & _
      "Title: " & desc.Title & "<br
 />" & _
      "Description: " & desc.Description &
 "<br />" & _
      "ImageUrl: " & desc.CatalogIconImageUrl
 & "<br />" & _
      "<hr />"
  Next
  
End Sub

C#

protected void Button1_Click(object sender,
 EventArgs e)
{
  Label1.Text = String.Empty;
  
  WebPartDescriptionCollection descriptions = 
    DeclarativeCatalogPart1.GetAvailableWebPartDescriptions();

  foreach (WebPartDescription desc in descriptions)
  {
    Label1.Text += "ID: " + desc.ID + "<br />" +
      "Title: " + desc.Title + "<br />" +
      "Description: " + desc.Description + "<br />" +
      "ImageUrl: " + desc.CatalogIconImageUrl + "<br />"
 +
      "<hr />";
  }
}

プラットフォーム

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

参照

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