System.Web.UI.WebControls.WebParts.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.

Syntax

public override string Description { set; get; }

Value

Documentation for this section has not yet been entered.

Remarks

The WebPart.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 WebPart.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 WebPart.DisplayTitle property, followed by a hyphen, followed by the WebPart.Description property value.

For a code example that uses this property, see the base Part.Description property.

The personalization scope of this property is set to PersonalizationScope.Shared and can be modified only by authorized users. For more information, see System.Web.UI.WebControls.WebParts.PersonalizableAttribute and Web Parts Personalization Overview.

Requirements

Namespace: System.Web.UI.WebControls.WebParts
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0