Sdílet prostřednictvím

WebPart.HelpMode Vlastnost

  • Reference

Definice

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

Získá nebo nastaví typ uživatelského rozhraní (UI) sloužící k zobrazení obsahu nápovědy pro ovládací prvek 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

Hodnota vlastnosti

WebPartHelpMode

Jedna z WebPartHelpMode hodnot. Výchozí formát je Modal.

Atributy
ThemeableAttribute PersonalizableAttribute

Výjimky

ArgumentOutOfRangeException

Zadaná hodnota není jednou z WebPartHelpMode hodnot.

Příklady

Následující příklad kódu ukazuje použití HelpMode vlastnosti k zobrazení nápovědy pro ovládací prvek ve stejném okně prohlížeče. První část tohoto příkladu předpokládá použití vlastního ovládacího prvku , TextDisplayWebPartkterý se nachází v části Příklad v 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 následující kód uložit do souboru s názvem Textwebparthelp.htm a umístit ho do stejného adresáře webu jako stránka .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>

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

HelpMode Pomocí vlastnosti určete, jak bude prohlížeč zobrazovat obsah nápovědy pro ovládací prvek. Následující tabulka uvádí účinky různých režimů nápovědy v prohlížeči při zobrazení obsahu nápovědy pro WebPart ovládací prvek.

Režim nápovědy Chování prohlížeče
Modal Pokud má prohlížeč tuto funkci, otevře samostatné okno prohlížeče. Uživatel musí okno před návratem na stránku webových částí zavřít.
Modeless Pokud má prohlížeč tuto funkci, otevře samostatné okno prohlížeče. Uživatel nemusí okno před návratem na webovou stránku zavřít.
Navigate Nahradí stránku webových částí v okně prohlížeče.

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

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ématu PersonalizableAttribute a Přehled přizpůsobení webových částí.

Platí pro

Viz také