WebPart.HelpUrl Propiedad

Definición

Obtiene o establece la dirección URL en un archivo de Ayuda de un control 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

Valor de propiedad

Una cadena que representa la dirección URL de un archivo de la Ayuda. El valor predeterminado es una cadena vacía ("").

Atributos

Excepciones

El sistema interno de validación ha determinado que la dirección URL puede contener ataques mediante script.

Ejemplos

En el ejemplo de código siguiente se muestra el uso de la HelpUrl propiedad . En este ejemplo se supone el uso de un control personalizado, TextDisplayWebPart, que se encuentra en la sección Ejemplo de la información general de la WebPart clase.

El ejemplo de código también incluye una página HTML que contiene contenido ficticio de ayuda para el TextDisplayWebPart control. Para que este ejemplo funcione, debe guardar el código siguiente en un archivo denominado Textwebparthelp.htm y colocarlo en el mismo directorio del sitio que la página .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 parte final del ejemplo es una página web que muestra cómo hacer referencia al TextDisplayWebPart control. Tenga en cuenta que, en el marcado declarativo, el valor de la HelpMode propiedad se establece Navigateen y el código también establece el valor de la HelpUrl propiedad en el nombre del archivo HTML que contiene el contenido de la Ayuda. Cargue la página en un explorador y haga clic en el verbo de ayuda en el menú verbos del WebPart control.

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

Comentarios

Para habilitar un menú de verbos con un verbo de ayuda en el menú verbos de un WebPart control, debe proporcionar un valor para la HelpUrl propiedad . La manera en que se muestra el contenido de la Ayuda en el explorador viene determinado por el valor de la HelpMode propiedad .

Esta propiedad no se puede establecer mediante temas o temas de la hoja de estilos. Para obtener más información, vea ThemeableAttribute y ASP.NET Temas y máscaras.

El ámbito de personalización de esta propiedad se establece Shared en y solo los usuarios autorizados pueden modificarlos. Para obtener más información, vea PersonalizableAttribute y Información general sobre personalización de elementos web.

Se aplica a

Consulte también