Export (0) Print
Expand All

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.

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

[PersonalizableAttribute(PersonalizationScope.Shared)]
public override string Description { get; set; }

Property Value

Type: System.String
A string that briefly summarizes the part control's functionality. The default value is an empty string ("").

Implements

IWebPart.Description

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 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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
Show:
© 2015 Microsoft