Share via

Visão geral do componente HelpProvider (Windows Forms)

  • Artigo

O componente HelpProvider dos Windows Forms é usado para associar um arquivo da Ajuda HTML 1.x (um arquivo .chm, produzido com o Workshop de Ajuda HTML ou um arquivo .htm) ao seu aplicativo do Windows. É possível fornecer ajuda de várias maneiras:

  • Fornece Ajuda contextual para controles nos Windows Forms.

  • 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 a página principal de um sumário, índice ou uma função de pesquisa.

Usando o provedor de ajuda

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

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

Se HelpNamespace não tiver sido definido, você deve usar SetHelpString para fornecer o texto da Ajuda. Se você tiver definido ambos HelpNamespace e a cadeia de caracteres da Ajuda, a Ajuda com base em HelpNamespace terá precedência.

Observação

Você pode encontrar problemas ao usar o caminho relativo ao especificar o caminho para o arquivo de Ajuda no ShowHelp método ou HelpNamespace propriedade do HelpProvider controle. Por isso, verifique se você usou o caminho de arquivo absoluto para especificar o arquivo de Ajuda.

Confira também