GenericWebPart.Description 属性
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
获取或设置一条短语,该短语在服务器控件的工具提示和目录中用来概述该控件的作用。
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
属性值
字符串,简要概述控件的功能。 默认值为空字符串 ("")。
示例
下面的代码示例演示了属性的 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 接口。