WebPart.Caption property

NOTE: This API is now obsolete.

Gets or sets a string that is added following the title in the title bar of the Web Part. This property is intended for document names or other context-specific information.

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


<ObsoleteAttribute("Use Subtitle instead.")> _
<WebPartStorageAttribute(Storage.None)> _
Public Property Caption As String
Dim instance As WebPart
Dim value As String

value = instance.Caption

instance.Caption = value
[ObsoleteAttribute("Use Subtitle instead.")]
public string Caption { get; set; }

Property value

Type: System.String
A string value for the text caption that is displayed following the Title property in the title bar. The default value is String.Empty.


The value of its WebPartStorageAttribute is Storage.None, which specifies that the property is not stored.

See also


WebPart class

WebPart members

Microsoft.SharePoint.WebPartPages namespace