WebPart.HelpMode Eigenschap

Definitie

Naamruimte:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Hiermee haalt u het type gebruikersinterface (UI) op dat wordt gebruikt om Help-inhoud voor een WebPart besturingselement weer te geven.

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

Waarde van eigenschap

WebPartHelpMode

Een van de WebPartHelpMode waarden. De standaardwaarde is Modal.

Kenmerken
ThemeableAttribute PersonalizableAttribute

Uitzonderingen

ArgumentOutOfRangeException

De opgegeven waarde is geen van de WebPartHelpMode waarden.

Voorbeelden

In het volgende codevoorbeeld ziet u het gebruik van de HelpMode eigenschap om Help voor een besturingselement in hetzelfde browservenster weer te geven. In het eerste deel van dit voorbeeld wordt ervan uitgegaan dat een aangepast besturingselement wordt gebruikt. TextDisplayWebPartDit vindt u in de sectie Voorbeeld van het WebPart klassenoverzicht.

Het codevoorbeeld bevat ook een HTML-pagina met fictieve Help-inhoud voor het TextDisplayWebPart besturingselement. Voor dit voorbeeld moet u de volgende code opslaan in een bestand met de naam Textwebparthelp.htm en deze in dezelfde map van uw site plaatsen als de .aspx pagina.

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

Het laatste deel van het voorbeeld is een webpagina die laat zien hoe u naar het TextDisplayWebPart besturingselement verwijst. Houd er rekening mee dat in de declaratieve markering de HelpMode eigenschapswaarde is ingesteld op Navigateen dat de code ook de waarde van de HelpUrl eigenschap instelt op de naam van het HTML-bestand dat de Help-inhoud bevat. Laad de pagina in een browser en klik op het Help-werkwoord in het menu Werkwoorden van het WebPart besturingselement.

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

Opmerkingen

Gebruik de HelpMode eigenschap om te bepalen hoe een browser Help-inhoud voor een besturingselement weergeeft. De volgende tabel bevat de effecten van de verschillende Help-modi in een browser wanneer Help-inhoud voor een WebPart besturingselement wordt weergegeven.

Help-modus Browsergedrag
Modal Hiermee opent u een afzonderlijk browservenster als de browser deze mogelijkheid heeft. Een gebruiker moet het venster sluiten voordat deze terugkeert naar de pagina Webonderdelen.
Modeless Hiermee opent u een afzonderlijk browservenster als de browser deze mogelijkheid heeft. Een gebruiker hoeft het venster niet te sluiten voordat hij terugkeert naar de webpagina.
Navigate Hiermee vervangt u de pagina Webonderdelen in het browservenster.

Deze eigenschap kan niet worden ingesteld op thema's of opmaakmodellen. Zie ThemeableAttribute en ASP.NET Thema's en skins voor meer informatie.

Het persoonlijke bereik van deze eigenschap is ingesteld op Shared en kan alleen worden gewijzigd door geautoriseerde gebruikers. Zie en PersonalizableAttribute voor meer informatie.

Van toepassing op

Zie ook