GenericWebPart::Description Property
Gets or sets a brief phrase that summarizes what a control does, for use in ToolTips and catalogs of server controls.
Assembly: System.Web (in System.Web.dll)
public: virtual property String^ Description { String^ get () override; void set (String^ value) override; }
<asp:GenericWebPart Description="String" />
Property Value
Type: System::StringA string that briefly summarizes the control's functionality. The default value is an empty string ("").
Implements
IWebPart::DescriptionThe Description property value is typically used as a descriptive string for a control in catalogs that provide lists of server controls, and as a ToolTip in a control's title bar. The content of the property appears in a ToolTip when a user positions the mouse pointer over the title text in a control's title bar.
This property overrides the base property so that you can access the property on the child control as if it were a true WebPart control.
You can set values for the property on your control in the declarative markup of a Web page, as well as programmatically. To provide a default value for the property whenever the control is used, you can implement the IWebPart interface.
The following code example demonstrates declarative and programmatic use of the Description property. The complete source code for the example is found in the Example section of the GenericWebPart overview topic.
The first part of the code example shows how the Description property is set declaratively on a server control within a WebPartZone control.
The second part of the code example demonstrates how to access the property programmatically to display its value in a label.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.