Share via

WebPart.HelpMode 属性

  • 参考

定义

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

获取或设置用于显示 WebPart 控件的帮助内容的用户界面 (UI) 的类型。

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

属性值

WebPartHelpMode

WebPartHelpMode 值之一。 默认值为 Modal。

属性
ThemeableAttribute PersonalizableAttribute

例外

ArgumentOutOfRangeException

指定的值不是 WebPartHelpMode 值之一。

示例

下面的代码示例演示如何使用 HelpMode 属性在同一浏览器窗口中显示控件的帮助。 此示例的第一部分假定使用自定义控件， 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>

注解

使用 HelpMode 属性确定浏览器如何显示控件的帮助内容。 下表列出了显示控件的帮助内容 WebPart 时，各种帮助模式对浏览器的影响。

帮助模式 浏览器行为
Modal 打开一个单独的浏览器窗口（如果浏览器具有此功能）。 用户在返回到 Web 部件页之前必须关闭该窗口。
Modeless 打开一个单独的浏览器窗口（如果浏览器具有此功能）。 用户在返回到网页之前无需关闭该窗口。
Navigate 替换浏览器窗口中的“Web 部件”页。

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

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

适用于

另请参阅