WebPart::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)
[PersonalizableAttribute(PersonalizationScope::Shared)] public: virtual property String^ Description { String^ get () override; void set (String^ value) override; }
<asp:WebPart Description="String" />
Property Value
Type: System::StringA string that briefly summarizes the part control's functionality. The default value is an empty string ("").
Implements
IWebPart::DescriptionThe 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 property 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.
For a code example that uses this property, see the base Description property.
The personalization scope of this property is set to Shared and can be modified only by authorized users. For more information, see PersonalizableAttribute and Web Parts Personalization Overview.
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.