通过

GenericWebPart.Description 属性

  • 参考

定义

命名空间:
System.Web.UI.WebControls.WebParts
程序集:
System.Web.dll

获取或设置一条短语，该短语在服务器控件的工具提示和目录中用来概述该控件的作用。

public:
 virtual property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };
public override string Description { get; set; }
member this.Description : string with get, set
Public Overrides Property Description As String

属性值

String

字符串，简要概述控件的功能。 默认值为空字符串 ("")。

示例

下面的代码示例演示如何以声明方式和编程方式使用 Description 属性。 有关示例的完整源代码，请参阅概述主题的“示例” GenericWebPart 部分。

代码示例的第一部分演示如何 Description 在 控件中的 WebPartZone 服务器控件上以声明方式设置 属性。

<asp:WebPartZone ID="WebPartZone1" runat="server">
  <ZoneTemplate>
    <asp:Calendar ID="Calendar1" runat="server"
      Title="My Calendar"
      Description="A calendar used as a GenericWebPart control."
      CatalogIconImageUrl="MyCatalogIcon.gif"
      TitleIconimageUrl ="MyTitleIcon.gif"
      TitleUrl="MyInfoUrl.htm" 
      Width="250"/>
  </ZoneTemplate>
</asp:WebPartZone>

<asp:WebPartZone ID="WebPartZone1" runat="server">
  <ZoneTemplate>
    <asp:Calendar ID="Calendar1" runat="server"
      Title="My Calendar"
      Description="A calendar used as a GenericWebPart control."
      CatalogIconImageUrl="MyCatalogIcon.gif"
      TitleIconimageUrl ="MyTitleIcon.gif"
      TitleUrl="MyInfoUrl.htm" 
      Width="250"/>
  </ZoneTemplate>
</asp:WebPartZone>

代码示例的第二部分演示如何以编程方式访问 属性，以在标签中显示其值。

protected void Button1_Click(object sender, EventArgs e)
{

  Label2.Text =
    @"<h3>Calendar GenericWebPart Properties</h3>" +
    "<em>Title: </em>" + calendarPart.Title +
    "<br />" +
    "<em>CatalogIconImageUrl:  </em>" + calendarPart.CatalogIconImageUrl +
    "<br />" +
    "<em>TitleUrl: </em>" + calendarPart.TitleUrl +
    "<br />" +
    "<em>Decription: </em>" + calendarPart.Description +
    "<br />" +
    "<em>TitleIconImageUrl: </em>" + calendarPart.TitleIconImageUrl +
    "<br />" +
    "<em>ChildControl ID: </em>" + calendarPart.ChildControl.ID +
    "<br />" +
    "<em>ChildControl Type: </em>" + calendarPart.ChildControl.GetType().Name +
    "<br />" +
    "<em>GenericWebPart ID: </em>" + calendarPart.ID +
    "<br />" +
    "<em>GenericWebPart Type: </em>" + calendarPart.GetType().Name +
    "<br />" +
    "<em>GenericWebPart Parent ID: </em>" + calendarPart.Parent.ID;

  Label3.Text =
    @"<h3>BulletedList GenericWebPart Properties</h3>" +
    "<em>Title: </em>" + listPart.Title +
    "<br />" +
    "<em>CatalogIconImageUrl:  </em>" + listPart.CatalogIconImageUrl +
    "<br />" +
    "<em>TitleUrl: </em>" + listPart.TitleUrl +
    "<br />" +
    "<em>Decription: </em>" + listPart.Description +
    "<br />" +
    "<em>TitleIconImageUrl: </em>" + listPart.TitleIconImageUrl +
    "<br />" +
    "<em>ChildControl ID: </em>" + listPart.ChildControl.ID +
    "<br />" +
    "<em>ChildControl Type: </em>" + listPart.ChildControl.GetType().Name +
    "<br />" +
    "<em>GenericWebPart ID: </em>" + listPart.ID +
    "<br />" +
    "<em>GenericWebPart Type: </em>" + listPart.GetType().Name +
    "<br />" +
    "<em>GenericWebPart Parent ID: </em>" + listPart.Parent.ID;
}

  Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)

    Label2.Text = _
      "<h3>Calendar GenericWebPart Properties</h3>" & _
      "<em>Title: </em>" & calendarPart.Title & _
      "<br />" & _
      "<em>CatalogIconImageUrl:  </em>" & calendarPart.CatalogIconImageUrl & _
      "<br />" & _
      "<em>TitleUrl: </em>" & calendarPart.TitleUrl & _
      "<br />" & _
      "<em>Decription: </em>" & calendarPart.Description & _
      "<br />" & _
      "<em>TitleIconImageUrl: </em>" & calendarPart.TitleIconImageUrl & _
      "<br />" & _
      "<em>ChildControl ID: </em>" & calendarPart.ChildControl.ID & _
      "<br />" & _
      "<em>ChildControl Type: </em>" & calendarPart.ChildControl.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart ID: </em>" & calendarPart.ID & _
      "<br />" & _
      "<em>GenericWebPart Type: </em>" & calendarPart.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart Parent ID: </em>" & calendarPart.Parent.ID

    Label3.Text = _
      "<h3>BulletedList GenericWebPart Properties</h3>" & _
      "<em>Title: </em>" & listPart.Title & _
      "<br />" & _
      "<em>CatalogIconImageUrl:  </em>" & listPart.CatalogIconImageUrl & _
      "<br />" & _
      "<em>TitleUrl: </em>" & listPart.TitleUrl & _
      "<br />" & _
      "<em>Decription: </em>" & listPart.Description & _
      "<br />" & _
      "<em>TitleIconImageUrl: </em>" & listPart.TitleIconImageUrl & _
      "<br />" & _
      "<em>ChildControl ID: </em>" & listPart.ChildControl.ID & _
      "<br />" & _
      "<em>ChildControl Type: </em>" & listPart.ChildControl.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart ID: </em>" & listPart.ID & _
      "<br />" & _
      "<em>GenericWebPart Type: </em>" & listPart.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart Parent ID: </em>" & listPart.Parent.ID
  End Sub

End Class

注解

属性值 Description 通常用作目录中提供服务器控件列表的控件的描述性字符串，以及控件标题栏中的工具提示。 当用户将鼠标指针置于控件标题栏中的标题文本上时，属性的内容将显示在工具提示中。

此属性重写基属性，以便你可以访问子控件上的属性，就好像它是一个真正的 WebPart 控件一样。

可以在网页的声明性标记中设置 控件上的 属性的值，也可以以编程方式设置。 若要在使用 控件时为 属性提供默认值，可以实现 IWebPart 接口。

适用于

另请参阅