WebPart.HelpMode Propriedade

Referência

Definição

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

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Obtém ou define o tipo de interface do usuário a ser usada para exibir o conteúdo de Ajuda para um controle 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 da propriedade

WebPartHelpMode

Um dos valores de WebPartHelpMode. O padrão é Modal.

Atributos: ThemeableAttribute PersonalizableAttribute

Exceções

ArgumentOutOfRangeException

O valor especificado não é um dos valores WebPartHelpMode.

Exemplos

O exemplo de código a seguir demonstra o uso da HelpMode propriedade para exibir a Ajuda para um controle na mesma janela do navegador. A primeira parte deste exemplo pressupõe o uso de um controle personalizado, TextDisplayWebPartque é encontrado na seção Exemplo da visão geral da WebPart classe.

O exemplo de código também inclui uma página HTML que contém conteúdo de Ajuda fictício para o TextDisplayWebPart controle. Para que este exemplo funcione, você deve salvar o código a seguir em um arquivo chamado Textwebparthelp.htm e colocá-lo no mesmo diretório do seu site que a 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>

A parte final do exemplo é uma página da Web que mostra como referenciar o TextDisplayWebPart controle. Observe que, na marcação declarativa, o valor da HelpMode propriedade é definido Navigatecomo , e o código também define o valor da HelpUrl propriedade como o nome do arquivo HTML que contém o conteúdo da Ajuda. Carregue a página em um navegador e clique no verbo de ajuda no menu de verbos do WebPart controle.

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

Comentários

Use a HelpMode propriedade para determinar como um navegador exibirá o conteúdo da Ajuda para um controle. A tabela a seguir lista os efeitos dos vários modos de Ajuda em um navegador quando o conteúdo da Ajuda para um WebPart controle é exibido.

Modo de ajuda	Comportamento do navegador
Modal	Abre uma janela de navegador separada quando o navegador tem essa funcionalidade. O usuário deve fechar a janela antes de retornar à página de Web Parts.
Modeless	Abre uma janela de navegador separada quando o navegador tem essa funcionalidade. O usuário não precisa fechar a janela antes de retornar à página da Web.
Navigate	Substitui a página de Web Parts na janela do navegador.

Essa propriedade não pode ser definida por temas ou temas de folha de estilos. Para obter mais informações, consulte ThemeableAttribute e ASP.NET Temas e Peles.

O escopo de personalização dessa propriedade é definido Shared como e só pode ser modificado por usuários autorizados. Para obter mais informações, consulte PersonalizableAttribute e Web Parts Visão geral da personalização.

Aplica-se a