WebPart.HelpMode Egenskap

Definition

Namnområde:
System.Web.UI.WebControls.WebParts
Sammansättning:
System.Web.dll

Hämtar eller anger vilken typ av användargränssnitt (UI) som används för att visa hjälpinnehåll för en WebPart kontroll.

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

Egenskapsvärde

WebPartHelpMode

Ett av WebPartHelpMode värdena. Standardvärdet är Modal.

Attribut
ThemeableAttribute PersonalizableAttribute

Undantag

ArgumentOutOfRangeException

Det angivna värdet är inte ett av WebPartHelpMode värdena.

Exempel

Följande kodexempel visar hur egenskapen används HelpMode för att visa Hjälp för en kontroll i samma webbläsarfönster. Den första delen av det här exemplet förutsätter användning av en anpassad kontroll, TextDisplayWebPart, som finns i avsnittet Exempel i klassöversikten WebPart .

Kodexemplet innehåller också en HTML-sida som innehåller fiktivt hjälpinnehåll för TextDisplayWebPart kontrollen. För att det här exemplet ska fungera måste du spara följande kod i en fil med namnet Textwebparthelp.htm och placera den i samma katalog på webbplatsen som .aspx sidan.

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

Den sista delen av exemplet är en webbsida som visar hur du TextDisplayWebPart refererar till kontrollen. Observera att i den deklarativa markeringen HelpMode anges egenskapsvärdet till Navigate, och koden anger även värdet HelpUrl för egenskapen till namnet på HTML-filen som innehåller hjälpinnehållet. Läs in sidan i en webbläsare och klicka på hjälpverb på kontrollens verbmeny 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>

Kommentarer

Använd egenskapen HelpMode för att avgöra hur en webbläsare ska visa hjälpinnehåll för en kontroll. I följande tabell visas effekterna av de olika hjälplägena i en webbläsare när Hjälpinnehåll för en WebPart kontroll visas.

Hjälpläge Webbläsarbeteende
Modal Öppnar ett separat webbläsarfönster om webbläsaren har den här funktionen. En användare måste stänga fönstret innan han eller hon återvänder till webbsidan.
Modeless Öppnar ett separat webbläsarfönster om webbläsaren har den här funktionen. En användare behöver inte stänga fönstret innan han eller hon återvänder till webbsidan.
Navigate Ersätter webbsidan i webbläsarfönstret.

Den här egenskapen kan inte anges med teman eller formatmallsteman. Mer information finns i ThemeableAttribute and ASP.NET Themes and Skins.

Anpassningsomfånget för den här egenskapen är inställt på Shared och kan endast ändras av behöriga användare. Mer information finns i PersonalizableAttributeoch Översikt över anpassning av webbdelar.

Gäller för

Se även