Como: Fornecer ajuda em um aplicativo Windows

Você pode usar o componente HelpProvider para conectar tópicos da Ajuda em um arquivo de ajuda a controles específicos em Formulários do Windows. O arquivo de Ajuda pode ser HTML ou HTMLHelp 1.x ou formato maior.

Observação
As caixas de diálogo e comandos de menu demonstradas podem ser diferentes daqueles descritos na Ajuda, dependendo das configurações ativas ou configurações de edição. Para alterar as configurações, escolha Import and Export Settings sobre o Ferramentas menu. Para obter mais informações, consulte Trabalhando com configurações.

Para fornecer ajuda

1. Da caixa de ferramentas ,arraste um componente HelpProvider ao seu formulário.

   O componente estará na bandeja na parte inferior do Windows Forms Designer.

2. Na janela Properties,defina a property HelpNamespace para .chm, .col ou .htm do arquivo de Ajuda.

3. Selecione outro controle que você tem em seu formulário, e no janela Properties, defina a property HelpKeyword.

   Esta é a sequência de caracteres passada por meio do componente HelpProvider para seu arquivo da Ajuda para chamar o tópico de ajuda apropriado.

4. Na janela Properties,defina a property HelpNavigator para um valor de enumeração de HelpNavigator.

   Isso determina a maneira na qual a property HelpKeyword é passada para o sistema de Ajuda. A tabela a seguir mostra as possíveis configurações e suas descrições.

   Nome do membro	Descrição
   AssociateIndex	Especifica que o índice para um tópico especificado é realizada na URL especificada.
   Localizar	Especifica que a página de pesquisa de em especificado URL é exibido.
   Índice	Especifica que o índice de uma URL especificada é exibido.
   KeywordIndex	Especifica uma palavra-chave para procurar e a ação a ser tomada na URL especificada.
   TableOfContents	Especifica que o índice de conteúdos do arquivo de ajuda HTML 1.0 será exibido.
   Tópico	Especifica que o tópico referênciado por uma URL especificada é exibido.

Em tempo de execução, pressionando F1 quando o controle — para que você tenha definido as properties HelpKeyword e HelpNavigator — tem o foco irá abrir o arquivo de ajuda que você associou com o componente HelpProvider.

Atualmente, o HelpNamespace propriedade oferece suporte a arquivos de Ajuda em três formatos a seguir: 1. HTMLHelp x, HTMLHelp 2.0 e HTML. Assim, você pode definir o HelpNamespace propriedade para um endereço http://, como, por exemplo, uma página da Web. Se isso for feito, abrirá o navegador padrão para o página da Web com a sequência especificada na property HelpKeyword usada como a âncora. A âncora é utilizada para saltar para uma parte específica de uma página HTML.

Observação sobre segurança

Tenha cuidado para verificar as informações que são enviadas a partir de um cliente antes de usá-las em seu aplicativo. Usuários mal-intencionados podem tentar enviar ou injetar script, instruções SQL ou outro código executáveis. Antes de exibir as entradas de um usuário, armazene-as num banco de dados ou trabalhe com elas, verificando se não contém informações potencialmente não seguras. Uma maneira comum para verificar é usar uma expressão regular para procurar palavras-chave como "script" quando você receber entrada de um usuário.

Você pode também utilizar o componente HelpProvider para exibir a pop-up de Ajuda, mesmo se você tiver isso configurado para exibir arquivos de Ajuda para os controles no seu formulário Windows. Para obter mais informações, consulte Como: Exibir a ajuda pop-up.

Consulte também

Tarefas

Como: Exibir a ajuda pop-up

Conceitos

Ajuda para os Controles Usando ToolTip

Outros recursos

Integrando a ajuda do usuário em Formulários do Windows

Windows Forms