O componente de HelpProvider Overview (Windows Forms)

  • Artigo

O Windows Forms HelpProvider componente é usado para associar um arquivo de Ajuda Ajuda HTML 1. x (um arquivo. chm, produzido com o HTML Help Workshop, ou um arquivo. htm) do seu aplicativo do Windows. Você pode fornecer ajuda de diversas maneiras:

  • Fornece ajuda contextual para controles em formulários do Windows.

  • Fornece ajuda contextual em uma caixa de diálogo específica ou controles específicos em uma caixa de diálogo.

  • Abra um arquivo de ajuda para áreas específicas, como, por exemplo, a página principal de um índice analítico, índice ou uma função de pesquisa.

Usando o provedor de ajuda

Adicionando um HelpProvider o componente ao seu formulário do Windows permite que os outros controles no formulário para expor as propriedades de Ajuda da HelpProvider componente. Isso permite que você fornecer ajuda para os controles do formulário do Windows. Você pode associar um arquivo de ajuda com o HelpProvider componente usando o HelpNamespace propriedade. Você especificar o tipo de ajuda fornecidos chamando SetHelpNavigator e fornecendo um valor a partir de HelpNavigator enumeração para o controle especificado. Fornecer a palavra-chave ou o tópico da Ajuda chamando o SetHelpKeyword método.

Opcionalmente, para associar uma seqüência de ajuda específica a outro controle, use o SetHelpString método. A seqüência de caracteres que você associar um controle usando esse método é exibida em uma janela pop-up quando o usuário pressiona a tecla F1 enquanto o controle tem foco.

Se HelpNamespace não foi definido, você deve usar SetHelpString para fornecer o texto de Ajuda. Se você tiver definido ambos HelpNamespace e a seqüência de caracteres de Ajuda, ajuda, com base em HelpNamespace terão precedência.

ObservaçãoObservação

Você pode encontrar problemas usando o caminho relativo ao especificar o caminho para o arquivo de ajuda no ShowHelp método ou HelpNamespace propriedade do HelpProvider de controle. Como tal, certifique-se de usar o caminho absoluto para especificar o arquivo de Ajuda.

Consulte também

Conceitos

Sistemas de Ajuda em Aplicativos de Formulários do Windows