WebPart.HelpUrl 屬性

  • 參考

定義

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

取得或設定 URL，該 URL 指向 WebPart 控制項的說明檔。

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 。 本範例假設使用類別概觀的範例區段中 WebPart 所找到的自訂控制項 TextDisplayWebPart 。

程式碼範例也包含 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 元件個人化概觀。

適用於

另請參閱