WebPart.HelpUrl 属性

  • 参考

定义

命名空间:
System.Web.UI.WebControls.WebParts
程序集:
System.Web.dll

获取或设置指向 WebPart 控件的帮助文件的 URL。

public:
 virtual property System::String ^ HelpUrl { System::String ^ get(); void set(System::String ^ value); };
[System.Web.UI.Themeable(false)]
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public virtual string HelpUrl { get; set; }
[<System.Web.UI.Themeable(false)>]
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.HelpUrl : string with get, set
Public Overridable Property HelpUrl As String

属性值

String

表示帮助文件的 URL 的字符串。 默认值为空字符串 ("")。

属性
ThemeableAttribute PersonalizableAttribute

例外

ArgumentException

内部验证系统已确定 URL 可能包含脚本攻击。

示例

下面的代码示例演示如何使用 HelpUrl 属性。 此示例假定使用自定义控件 ， TextDisplayWebPart该控件位于类概述的 WebPart “示例”部分。

该代码示例还包括一个 HTML 页，其中包含控件的 TextDisplayWebPart 虚构帮助内容。 若要使此示例正常工作，必须将以下代码保存在名为 Textwebparthelp.htm 的文件中，并将其放置在与 .aspx 页面相同的站点目录中。

<html>  
<head runat="server">  
    <title>Text Content WebPart Help</title>  
</head>  
<body>  
  <div>  
  <h1>Text Content WebPart Help</h1>  
  To make the WebPart control work...  
  </div>  
</body>  
</html>

该示例的最后一部分是显示如何引用控件的 TextDisplayWebPart 网页。 请注意，在声明性标记中 HelpMode ，属性值设置为 Navigate，代码还会将 属性的值 HelpUrl 设置为包含帮助内容的 HTML 文件的名称。 将页面加载到浏览器中，然后单击控件的谓词菜单上的 WebPart 帮助谓词。

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            width="350px" 
            HelpMode="navigate"
            HelpUrl="TextWebPartHelp.htm" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            width="350px" 
            HelpMode="navigate"
            HelpUrl="TextWebPartHelp.htm" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

注解

若要在控件的谓词菜单中启用带有帮助谓词的 WebPart 谓词菜单，必须为 属性提供值 HelpUrl 。 帮助内容在浏览器中的显示方式由 属性的值 HelpMode 决定。

无法通过主题或样式表主题设置此属性。 有关详细信息，请参阅 ThemeableAttribute 和 ASP.NET 主题和外观。

此属性的个性化设置范围设置为 Shared ，并且只能由授权用户修改。 有关详细信息，请参阅 PersonalizableAttribute 和 Web 部件个性化概述。

适用于

另请参阅