Export (0) Print
Expand All

WebPart.Description Property

Note: This property is new in the .NET Framework version 2.0.

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)

public override string Description { get; set; }
/** @property */
public String get_Description ()

/** @property */
public void set_Description (String value)

public override function get Description () : String

public override function set Description (value : String)

Property Value

A 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 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 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2015 Microsoft