Sdílet prostřednictvím

WebPart.HelpUrl Vlastnost

  • Reference

Definice

Obor názvů:
System.Web.UI.WebControls.WebParts
Sestavení:
System.Web.dll

Získá nebo nastaví adresu URL souboru nápovědy pro ovládací prvek 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

Hodnota vlastnosti

String

Řetězec, který představuje adresu URL souboru nápovědy. Výchozí hodnota je prázdný řetězec ("").

Atributy
ThemeableAttribute PersonalizableAttribute

Výjimky

ArgumentException

Interní ověřovací systém zjistil, že adresa URL může obsahovat útoky pomocí skriptů.

Příklady

Následující příklad kódu ukazuje použití HelpUrl vlastnosti . Tento příklad předpokládá použití vlastního ovládacího prvku TextDisplayWebPart, který se nachází v části Příklad přehledu WebPart třídy.

Příklad kódu obsahuje také stránku HTML, která obsahuje fiktivní obsah nápovědy TextDisplayWebPart pro ovládací prvek. Aby tento příklad fungoval, musíte uložit následující kód do souboru s názvem Textwebparthelp.htm a umístit ho do stejného adresáře webu jako .aspx stránku.

<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>

Poslední částí příkladu je webová stránka, která ukazuje, jak odkazovat na TextDisplayWebPart ovládací prvek. Všimněte si, HelpMode že v deklarativním kódu je hodnota vlastnosti nastavena na Navigatehodnotu a kód také nastaví hodnotu HelpUrl vlastnosti na název souboru HTML, který obsahuje obsah nápovědy. Načtěte stránku do prohlížeče a klikněte na příkaz nápovědy v nabídce WebPart sloves ovládacího prvku.

<%@ 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>

Poznámky

Chcete-li povolit nabídku sloves s příkazem nápovědy v nabídce WebPart sloves ovládacího prvku, musíte zadat hodnotu vlastnosti HelpUrl . Způsob zobrazení obsahu nápovědy v prohlížeči je určen hodnotou HelpMode vlastnosti .

Tuto vlastnost nelze nastavit pomocí motivů nebo šablon stylů. Další informace najdete v tématu ThemeableAttribute a ASP.NET Motivy a skiny.

Rozsah přizpůsobení této vlastnosti je nastaven na Shared hodnotu a může být upraven pouze autorizovanými uživateli. Další informace najdete v tématech PersonalizableAttribute a Přehled přizpůsobení webových částí.

Platí pro

Viz také