Compartir a través de

WebPart.HelpMode Propiedad

  • Referencia

Definición

Espacio de nombres:
System.Web.UI.WebControls.WebParts
Ensamblado:
System.Web.dll

Obtiene o establece el tipo de interfaz de usuario usada para mostrar el contenido de la Ayuda de un control WebPart.

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

Valor de propiedad

WebPartHelpMode

Uno de los valores de WebPartHelpMode. De manera predeterminada, es Modal.

Atributos
ThemeableAttribute PersonalizableAttribute

Excepciones

ArgumentOutOfRangeException

El valor especificado no es ninguno de los valores de WebPartHelpMode.

Ejemplos

En el ejemplo de código siguiente se muestra el uso de la HelpMode propiedad para mostrar ayuda para un control en la misma ventana del explorador. La primera parte de este ejemplo 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 de .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

Utilice la HelpMode propiedad para determinar cómo un explorador mostrará el contenido de ayuda de un control. En la tabla siguiente se enumeran los efectos de los distintos modos de Ayuda en un explorador cuando se muestra el contenido de ayuda de un WebPart control.

Modo de ayuda Comportamiento del explorador
Modal Abre una ventana diferente del explorador, si el explorador tiene esta capacidad. El usuario debe cerrar la ventana antes de regresar a la página de elementos Web.
Modeless Abre una ventana diferente del explorador, si el explorador tiene esta capacidad. El usuario no tiene que cerrar la ventana antes de regresar a la página Web.
Navigate Reemplaza la página de elementos Web en la ventana del explorador.

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

El ámbito de personalización de esta propiedad se establece en Shared 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