WebPart.HelpUrl Propriété

  • Référence

Définition

Espace de noms:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Obtient ou définit l'URL d'un fichier d'aide pour un contrôle WebPart.

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

Valeur de propriété

String

Chaîne qui représente l'URL d'un fichier d'aide. La valeur par défaut est une chaîne vide ("").

Attributs
ThemeableAttribute PersonalizableAttribute

Exceptions

ArgumentException

Le système de validation interne a déterminé que l'URL peut contenir des attaques de script.

Exemples

L’exemple de code suivant illustre l’utilisation de la HelpUrl propriété . Cet exemple suppose l’utilisation d’un contrôle personnalisé, TextDisplayWebPart, qui se trouve dans la section Exemple de la vue d’ensemble de la WebPart classe.

L’exemple de code inclut également une page HTML qui contient du contenu d’aide fictif pour le TextDisplayWebPart contrôle. Pour que cet exemple fonctionne, vous devez enregistrer le code suivant dans un fichier nommé Textwebparthelp.htm et le placer dans le même répertoire de votre site que la page .aspx.

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

La dernière partie de l’exemple est une page Web qui montre comment référencer le TextDisplayWebPart contrôle. Notez que dans le balisage déclaratif, la valeur de la HelpMode propriété est définie Navigatesur , et le code définit également la valeur de la HelpUrl propriété sur le nom du fichier HTML qui contient le contenu de l’aide. Chargez la page dans un navigateur, puis cliquez sur le verbe d’aide dans le menu verbes du WebPart contrôle.

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

Remarques

Pour activer un menu verbe avec un verbe d’aide dans le menu verbes d’un WebPart contrôle, vous devez fournir une valeur pour la HelpUrl propriété . La façon dont le contenu de l’aide est affiché dans le navigateur est déterminée par la valeur de la HelpMode propriété .

Cette propriété ne peut pas être définie par les thèmes ou les thèmes de feuille de style. Pour plus d’informations, consultez ThemeableAttribute et ASP.NET Thèmes et apparences.

L’étendue de personnalisation de cette propriété est définie sur Shared et ne peut être modifiée que par les utilisateurs autorisés. Pour plus d’informations, consultez PersonalizableAttributeVue d’ensemble de la personnalisation des composants WebPart.

S’applique à

Voir aussi