WebPartHelpMode Enumeration

Definition

Gibt die verfügbaren Typen von Benutzeroberflächen zum Anzeigen des Hilfeinhalts für ein WebPart-Steuerelement an.

public enum class WebPartHelpMode
public enum WebPartHelpMode
type WebPartHelpMode = 
Public Enum WebPartHelpMode
Vererbung
WebPartHelpMode

Felder

Modal 0

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

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

Ersetzt die Webparts-Seite im Browserfenster.

Beispiele

Im folgenden Beispiel wird die Verwendung der WebPart.HelpMode -Eigenschaft veranschaulicht, um die Hilfe für ein Steuerelement im selben Browserfenster anzuzeigen. Der erste Teil dieses Beispiels setzt die Verwendung eines benutzerdefinierten Steuerelements voraus, TextDisplayWebPartdas im Abschnitt Beispiele der WebPart -Klasse zu finden ist.

Das Beispiel 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 namens Textwebparthelp.htm speichern und ihn im gleichen Verzeichnis Ihrer Website wie die seite .aspx 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 WebPart.HelpMode Eigenschaftswert auf Navigatefestgelegt ist, und der Code legt auch den Wert der WebPart.HelpUrl Eigenschaft auf den Namen der HTML-Datei fest, die den Hilfeinhalt enthält. Laden Sie die Seite in einen Browser, und klicken Sie im Menü Verben des Steuerelements auf das WebPart Hilfeverb.

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

Die HelpMode -Eigenschaft wird verwendet, um zu bestimmen, wie ein Browser Hilfeinhalte für ein Steuerelement anzeigt. Die WebPartHelpMode -Enumeration enthält Werte, die auf die HelpMode -Eigenschaft angewendet werden können. Der Standardwert für die HelpMode Eigenschaft ist Modal.

Gilt für: