WebPart.Description property

Gets or sets a text description that appears when the user rests the mouse pointer on the title of a Web Part in a Web Part Page or gallery.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)


<WebPartStorageAttribute(Storage := Storage.Shared)> _
Public Overrides Property Description As String
Dim instance As WebPart
Dim value As String

value = instance.Description

instance.Description = value
[WebPartStorageAttribute(Storage = Storage.Shared)]
public override string Description { get; set; }

Property value

Type: System.String
A string that specifies a description of a Web Part. The default value is String.Empty.




This property cannot be personalized by individual users. The value of its WebPartStorageAttribute is Storage.Shared, which specifies that the property will be stored with the same value for all users. Only users with the Write web pages right can set this property. It can be set programmatically, or it can be set through the Web Part task pane in the shared view of the Web-based user interface, or by using a SharePoint Foundation–compatible HTML editor, such as SharePoint Designer.

See also


WebPart class

WebPart members

Microsoft.SharePoint.WebPartPages namespace