WebPart.HelpMode 屬性

  • 參考

定義

命名空間:
System.Web.UI.WebControls.WebParts
組件:
System.Web.dll

取得或設定使用者介面 (UI) 型別，該型別要用來顯示 WebPart 控制項的 [說明] 內容。

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 Example 區段中。

程式碼範例也包含 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 如果瀏覽器有此功能，要另外開啟瀏覽器視窗。 使用者不需要關閉視窗，就能返回 Web 網頁。
Navigate 取代瀏覽器視窗中的 Web 組件頁面。

這個屬性無法由佈景主題或樣式表主題設定。 如需詳細資訊，請參閱 ThemeableAttribute 和ASP.NET 主題和外觀。

此屬性的個人化範圍設定為 Shared ，且只能由授權的使用者修改。 如需詳細資訊，請參閱 PersonalizableAttribute 和Web 組件個人化概觀。

適用於

另請參閱