WebPart.HelpUrl Właściwość

  • Odwołanie

Definicja

Przestrzeń nazw:
System.Web.UI.WebControls.WebParts
Zestaw:
System.Web.dll

Pobiera lub ustawia adres URL pliku Pomocy dla kontrolki 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

Wartość właściwości

String

Ciąg reprezentujący adres URL pliku Pomocy. Wartością domyślną jest ciąg pusty ("").

Atrybuty
ThemeableAttribute PersonalizableAttribute

Wyjątki

ArgumentException

Wewnętrzny system weryfikacji ustalił, że adres URL może zawierać ataki skryptu.

Przykłady

Poniższy przykład kodu przedstawia użycie HelpUrl właściwości. W tym przykładzie przyjęto założenie, że użycie kontrolki niestandardowej znajduje TextDisplayWebPartsię w sekcji Przykład w przeglądzie WebPart klasy.

Przykładowy kod zawiera również stronę HTML zawierającą fikcyjną zawartość Pomocy dla kontrolki TextDisplayWebPart . W tym przykładzie należy zapisać następujący kod w pliku o nazwie Textwebparthelp.htm i umieścić go w tym samym katalogu witryny co strona 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>

Ostatnią częścią przykładu jest strona internetowa przedstawiająca sposób odwołowania się do kontrolki TextDisplayWebPart . Należy pamiętać, HelpMode że w deklaratywnej adiustacji wartość właściwości jest ustawiona na Navigate, a kod ustawia również wartość HelpUrl właściwości na nazwę pliku HTML zawierającego zawartość Pomocy. Załaduj stronę do przeglądarki i kliknij zlecenie pomocy w menu czasowników kontrolki 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>

Uwagi

Aby włączyć menu czasownika z zleceniem pomocy w menu WebPart czasowników kontrolki, musisz podać wartość właściwości HelpUrl . Sposób, w jaki zawartość Pomocy jest wyświetlana w przeglądarce, zależy od wartości HelpMode właściwości.

Nie można ustawić tej właściwości według motywów ani motywów arkusza stylów. Aby uzyskać więcej informacji, zobacz ThemeableAttributei ASP.NET Motywy i skóry.

Zakres personalizacji tej właściwości jest ustawiony na Shared i może być modyfikowany tylko przez autoryzowanych użytkowników. Aby uzyskać więcej informacji, zobacz PersonalizableAttribute Omówienie personalizacji składników Web Part.

Dotyczy

Zobacz też