WebPartDescription.Description プロパティ

定義

名前空間:

System.Web.UI.WebControls.WebParts

アセンブリ:

System.Web.dll

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

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

public string Description { get; }

member this.Description : string

Public ReadOnly Property Description As String

プロパティ値

String

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

例

次のコード例は、 プロパティのプログラムによる使用を Description 示しています。 このコード例を実行するために必要な完全なコードについては、クラスの概要に関するトピックの「例」セクションを WebPartDescription 参照してください。

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

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 />";
  }
}

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

注釈

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

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

こちらもご覧ください

• Description
• ASP.NET Web パーツ コントロール