通过

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 部分。

网页 方法中的Button1_Click以下代码演示如何使用 GetAvailableWebPartDescriptions 方法获取目录中对象的WebPartDescription集合，然后通过循环访问 WebPartDescription 对象来显示目录中每个WebPart控件的详细信息。 请注意，将在 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 属性才适用。 如果控件分配了说明，说明将在目录中显示为控件上的工具提示。

适用于

另请参阅