Partilhar via

Como: Fornecer ajuda em um aplicativo do Windows

  • Artigo

Você pode usar o componente HelpProvider para anexar tópicos da Ajuda em um arquivo de Ajuda a controles específicos no Windows Forms. O arquivo de Ajuda pode ser HTML ou HTMLHelp 1.x ou formato superior.

Fornecer ajuda

  1. No Visual Studio, naCaixa de Ferramentas , arraste um componente para o formulário.

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

  2. Na janela Propriedades, defina a propriedade HelpNamespace como ficheiro .chm, .col ou .htm de Ajuda.

  3. Selecione outro controle que você tem em seu formulário e, na janela Propriedades , defina a propriedade .

    Esta é a cadeia de caracteres passada pelo componente HelpProvider para o ficheiro de Ajuda para convocar o tópico de Ajuda adequado.

  4. Na janela Properties, defina a propriedade SetHelpNavigator como um valor da enumeração HelpNavigator.

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

    Nome do Membro Descrição
    AssociateIndex Especifica que o índice de um tópico especificado é executado na URL especificada.
    Encontrar Especifica que a página de pesquisa de um URL especificado é exibida.
    Índice Especifica que o índice de uma URL especificada é exibido.
    Índice de palavras-chave Especifica uma palavra-chave a ser pesquisada e a ação a ser executada na URL especificada.
    Índice Especifica que o sumário do arquivo de Ajuda HTML 1.0 é exibido.
    Tópico Especifica que o tópico referenciado pela URL especificada é exibido.

Em tempo de execução, pressionar F1 quando o controle — para o qual você definiu o HelpKeyword e propriedades de HelpNavigator — tiver foco abrirá o arquivo de Ajuda associado a esse componente HelpProvider.

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

Importante

Tenha cuidado para verificar qualquer informação que é enviada de um cliente antes de usá-lo em seu aplicativo. Usuários mal-intencionados podem tentar enviar ou injetar script executável, instruções SQL ou outro código. Antes de exibir a entrada de um usuário, armazená-la em um banco de dados ou trabalhar com ela, verifique se ela não contém informações potencialmente inseguras. Uma maneira típica de verificar é usar uma expressão regular para procurar palavras-chave como "SCRIPT" quando você recebe entrada de um usuário.

Você também pode usar o componente HelpProvider para mostrar a ajuda pop-up, mesmo que o tenha configurado para exibir ficheiros de ajuda para os controlos nos seus Windows Forms. Para obter mais informações, consulte Como: Exibir ajuda em pop-up.

Ver também