Export (0) Print
Expand All

WebPart.HelpLink property

NOTE: This API is now obsolete.

Gets or sets a URL or file system path to a help file in HTML format.

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

[HtmlDesignerAttribute("", HtmlEditorBuilderType = "file")]
[WebPartStorageAttribute(Storage.Shared)]
[ObsoleteAttribute("Use HelpUrl instead.")]
public string HelpLink { get; set; }

Property value

Type: System.String
A string that specifies a URL to an HTML file that can be used to provide descriptive information or instructions. The default value is String.Empty.

Use this property to return content that will help the end user interact with a Web Part. When you set this property, the Web Part infrastructure adds a Help command to the Web Part menu during rendering. Clicking the Help command opens a new browser window, which navigates to this URL.

This property cannot be personalized by individual users. The value of its WebPartStorageAttribute is Storage.Shared, which specifies that the property is 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.

Community Additions

Show:
© 2014 Microsoft