WebPart.HelpUrl Eigenschap

Definitie

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

Haalt de URL op of stelt deze in op een Help-bestand voor een WebPart besturingselement.

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

Waarde van eigenschap

String

Een tekenreeks die de URL naar een Help-bestand vertegenwoordigt. De standaardwaarde is een lege tekenreeks ("").

Kenmerken
ThemeableAttribute PersonalizableAttribute

Uitzonderingen

ArgumentException

Het interne validatiesysteem heeft vastgesteld dat de URL scriptaanvallen kan bevatten.

Voorbeelden

In het volgende codevoorbeeld ziet u hoe de HelpUrl eigenschap wordt gebruikt. In 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

Als u een werkwoordmenu wilt inschakelen met een Help-werkwoord in het menu Werkwoorden van een WebPart besturingselement, moet u een waarde voor de HelpUrl eigenschap opgeven. De manier waarop de Help-inhoud in de browser wordt weergegeven, wordt bepaald door de waarde van de HelpMode eigenschap.

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