WebPart.HelpLink 属性
请注意:此 API 现在已过时。
获取或设置帮助文件以 HTML 格式的 URL 或文件系统路径。
命名空间: Microsoft.SharePoint.WebPartPages
程序集: Microsoft.SharePoint(位于 Microsoft.SharePoint.dll 中)
语法
声明
<WebPartStorageAttribute(Storage.Shared)> _
<HtmlDesignerAttribute("", HtmlEditorBuilderType := "file")> _
<ObsoleteAttribute("Use HelpUrl instead.")> _
Public Property HelpLink As String
Get
Set
用法
Dim instance As WebPart
Dim value As String
value = instance.HelpLink
instance.HelpLink = value
[WebPartStorageAttribute(Storage.Shared)]
[HtmlDesignerAttribute("", HtmlEditorBuilderType = "file")]
[ObsoleteAttribute("Use HelpUrl instead.")]
public string HelpLink { get; set; }
属性值
类型:System.String
指定可用于提供的描述性信息或说明的 HTML 文件的 URL string 。默认值是String.Empty。
备注
使用此属性可返回与 Web 部件将帮助最终用户交互的内容。当设置此属性时,Web 部件基础结构将呈现过程将帮助命令添加到 Web 部件菜单上。单击帮助命令将打开一个新的浏览器窗口,导航到此 URL。
此属性不能由单个用户进行个性化设置。WebPartStorageAttribute其值为Storage.Shared,用于指定属性存储的所有用户的相同值。只有具有写网页右侧的用户可以设置该属性。以编程方式,可以将或通过基于 Web 的用户界面,或使用SharePoint Foundation的共享视图中的 Web 部件任务窗格可以将设置-兼容的 HTML 编辑器如SharePoint Designer。