Part.Description Property
Gets or sets a brief phrase that summarizes what the part control does, for use in ToolTips and catalogs of part controls.
Assembly: System.Web (in System.Web.dll)
Property Value
Type: System.StringA string that briefly summarizes the part control's functionality. The default value is an empty string ("").
The Description property is typically a string that is used in catalogs that provide lists of part controls, and as a ToolTip in the part control's title bar. The content of the Description appears in a ToolTip when you position your mouse pointer over the title text in a part control's title bar. The ToolTip text is created from the value of the DisplayTitle property, followed by a hyphen, followed by the Description property value.
The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and ASP.NET Globalization and Localization.
Notes to Inheritors:
Derived classes such as WebPart can override Description to enable user personalization of the control's description.
The following code example illustrates the declarative use of the Description property in a part control. This example requires the custom WebPart control TextDisplayWebPart, which can be found in the Example section of the Part class summary.
After you load the page in a browser, if you position your mouse pointer over the title text of the first control instance, the description text appears in a ToolTip.
<%@ page language="VB" %> <%@ register tagprefix="aspSample" Namespace="Samples.AspNet.VB.Controls" Assembly="TextDisplayWebPartVB" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head id="Head1" runat="server"> <title>ASP.NET Example</title> </head> <body> <form id="Form1" runat="server"> <asp:webpartmanager id="WebPartManager1" runat="server" /> <asp:webpartzone id="WebPartZone1" runat="server" backcolor="#99cccc"> <parttitlestyle font-bold="true" forecolor="#ffffff" /> <partstyle borderwidth="1px" borderstyle="Solid" bordercolor="#81AAF2" /> <zonetemplate> <aspSample:TextDisplayWebPart runat="server" id="textwebpart" title = "Text Content WebPart" Description="A text content WebPart control." ChromeType="TitleAndBorder" width="350px" /> </zonetemplate> </asp:webpartzone> <asp:webpartzone id="WebPartZone2" runat="server" backcolor="#99cccc"> <parttitlestyle font-bold="true" forecolor="#ffffff" /> <partstyle borderwidth="1px" borderstyle="Solid" bordercolor="#81AAF2" /> <zonetemplate> <aspSample:TextDisplayWebPart runat="server" id="textwebpart2" title = "Text Content WebPart 2" Description="A text content WebPart control." ChromeType="TitleOnly" ChromeState="Minimized" width="350px" /> </zonetemplate> </asp:webpartzone> </form> </body> </html>
Available since 2.0