WebPart.HelpMode Eigenschaft

  • Referenz

Definition

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

Ruft den Typ der Benutzeroberfläche ab, auf der Hilfeinhalt für ein WebPart-Steuerelement angezeigt werden soll, oder legt diesen fest.

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

Eigenschaftswert

WebPartHelpMode

Einer der WebPartHelpMode-Werte. Der Standardwert ist Modal.

Attribute
ThemeableAttribute PersonalizableAttribute

Ausnahmen

ArgumentOutOfRangeException

Der angegebene Wert ist keiner der WebPartHelpMode-Werte.

Beispiele

Das folgende Codebeispiel veranschaulicht die Verwendung der -Eigenschaft zum Anzeigen der HelpMode Hilfe für ein Steuerelement im selben Browserfenster. Im ersten Teil dieses Beispiels wird von der Verwendung eines benutzerdefinierten Steuerelements ausgegangen, TextDisplayWebPartdas sich im Abschnitt Beispiel der WebPart Klassenübersicht befindet.

Das Codebeispiel enthält auch eine HTML-Seite, die fiktive Hilfeinhalte für das TextDisplayWebPart Steuerelement enthält. Damit dieses Beispiel funktioniert, müssen Sie den folgenden Code in einer Datei mit dem Namen Textwebparthelp.htm speichern und ihn im gleichen Verzeichnis Ihrer Website wie die .aspx Seite ablegen.

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

Der letzte Teil des Beispiels ist eine Webseite, die zeigt, wie auf das TextDisplayWebPart Steuerelement verwiesen wird. Beachten Sie, dass im deklarativen Markup der HelpMode Eigenschaftswert auf Navigatefestgelegt ist und der Code auch den Wert der HelpUrl Eigenschaft auf den Namen der HTML-Datei festlegt, die den Hilfeinhalt enthält. Laden Sie die Seite in einen Browser, und klicken Sie im Menü Verben des Steuerelements auf das WebPart Hilfeverben.

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

Hinweise

Verwenden Sie die HelpMode -Eigenschaft, um zu bestimmen, wie ein Browser Hilfeinhalte für ein Steuerelement anzeigt. In der folgenden Tabelle sind die Auswirkungen der verschiedenen Hilfemodi auf einen Browser aufgeführt, wenn Hilfeinhalte für ein WebPart Steuerelement angezeigt werden.

Hilfemodus Browserverhalten
Modal Öffnet ein separates Browserfenster, wenn der Browser diese Möglichkeit besitzt. Benutzer müssen das Fenster schließen, bevor sie zur Webparts-Seite zurückkehren.
Modeless Öffnet ein separates Browserfenster, wenn der Browser diese Möglichkeit besitzt. Benutzer müssen das Fenster nicht schließen, bevor sie zur Webseite zurückkehren.
Navigate Ersetzt die Webparts-Seite im Browserfenster.

Diese Eigenschaft kann nicht durch Designs oder Stylesheetdesigns festgelegt werden. Weitere Informationen finden Sie unter ThemeableAttribute und ASP.NET-Designs und Skins.

Der Personalisierungsbereich dieser Eigenschaft ist auf Shared festgelegt und kann nur von autorisierten Benutzern geändert werden. Weitere Informationen finden Sie unter PersonalizableAttributeund Übersicht über die Webpart-Personalisierung.

Gilt für:

Weitere Informationen