Share via


WebPart.HelpUrl Property

Gets or sets a Help link.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<WebPartStorageAttribute(Storage.None)> _
Public Overrides Property HelpUrl As String
    Get
    Set
'Usage
Dim instance As WebPart
Dim value As String

value = instance.HelpUrl

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

Property Value

Type: System.String
A string containing a URL. The default value is String.Empty.

Remarks

If you provide a value for the HelpUrl property, a Help item is added to the Web Part menu. When a user clicks Help on the menu, content at the URL displays in the browser. You can use the HelpMode() property to control how the browser displays Help content.

See Also

Reference

WebPart Class

WebPart Members

Microsoft.SharePoint.WebPartPages Namespace