WebPart.HelpUrl Eigenschaft

  • Referenz

Definition

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

Ruft die URL zu einer Hilfedatei für ein WebPart-Steuerelement ab oder legt diese fest.

public:
 virtual property System::String ^ HelpUrl { System::String ^ get(); void set(System::String ^ value); };
[System.Web.UI.Themeable(false)]
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public virtual string HelpUrl { get; set; }
[<System.Web.UI.Themeable(false)>]
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.HelpUrl : string with get, set
Public Overridable Property HelpUrl As String

Eigenschaftswert

String

Eine Zeichenfolge, die die URL zu einer Hilfedatei darstellt. Der Standardwert ist eine leere Zeichenfolge ("").

Attribute
ThemeableAttribute PersonalizableAttribute

Ausnahmen

ArgumentException

Das interne Validierungssystem hat ermittelt, dass die URL Skriptangriffe enthalten könnte.

Beispiele

Im folgenden Codebeispiel wird die Verwendung des HelpUrl-Attributs veranschaulicht. In diesem Beispiel wird davon ausgegangen, dass ein benutzerdefiniertes Steuerelement verwendet wird, 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 namens 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 legt auch den Wert der 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

Um ein Verbmenü mit einem Hilfeverb im Verbenmenü eines WebPart Steuerelements zu aktivieren, müssen Sie einen Wert für die HelpUrl -Eigenschaft angeben. Die Art und Weise, wie der Hilfeinhalt im Browser angezeigt wird, wird durch den Wert der HelpMode -Eigenschaft bestimmt.

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 PersonalizableAttribute und Übersicht über die Personalisierung von Webparts.

Gilt für:

Weitere Informationen