Compartilhar via

WebPart.HelpUrl Propriedade

  • Referência

Definição

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

Obtém ou define a URL para um arquivo de Ajuda para um controle 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 da propriedade

String

Uma cadeia de caracteres que representa a URL para um arquivo de Ajuda. O valor padrão é uma cadeia de caracteres vazia ("").

Atributos
ThemeableAttribute PersonalizableAttribute

Exceções

ArgumentException

O sistema de validação interno determinou que a URL pode conter os ataques de script.

Exemplos

O exemplo de código a seguir demonstra o uso da HelpUrl propriedade . Este exemplo pressupõe o uso de um controle personalizado, TextDisplayWebPart, que é 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 fictício da Ajuda 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

Para habilitar um menu de verbo com um verbo de ajuda no menu de verbos de um WebPart controle, você deve fornecer um valor para a HelpUrl propriedade . A maneira como o conteúdo da Ajuda é exibido no navegador é determinada pelo valor da HelpMode propriedade .

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 como Shared e só pode ser modificado por usuários autorizados. Para obter mais informações, consulte PersonalizableAttribute e Visão geral da Personalização de Web Parts.

Aplica-se a

Confira também