Export (0) Print
Expand All
Expand Minimize

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)
Available in Sandboxed Solutions: No

'Declaration
<ObsoleteAttribute("Use Subtitle instead.")> _
<WebPartStorageAttribute(Storage.None)> _
PublicPropertyCaptionAsStringGetSet
'Usage
DiminstanceAsWebPartDimvalueAsStringvalue = instance.Caption

instance.Caption = value

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.

Show:
© 2014 Microsoft