WebPartHelpMode 枚举

定义

指定用于显示 WebPart 控件的帮助内容的用户界面 (UI) 的可用类型。

public enum class WebPartHelpMode
public enum WebPartHelpMode
type WebPartHelpMode = 
Public Enum WebPartHelpMode
继承
WebPartHelpMode

字段

Modal 0

打开一个单独的浏览器窗口(如果浏览器具有此功能)。 用户在返回到 Web 部件页之前必须关闭该窗口。

Modeless 1

打开一个单独的浏览器窗口(如果浏览器具有此功能)。 用户在返回到网页之前无需关闭该窗口。

Navigate 2

替换浏览器窗口中的“Web 部件”页。

示例

以下示例演示如何使用 WebPart.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 网页。 请注意,在声明性标记中 WebPart.HelpMode ,属性值设置为 Navigate,代码还会将 属性的值 WebPart.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 用于确定浏览器如何显示控件的帮助内容。 枚举 WebPartHelpMode 包含可应用于 HelpMode 属性的值。 属性的 HelpMode 默认值为 Modal。

适用于