Como: Especificar uma ajuda Arquivo para o componente
Em a maioria das situações, você deve deixar os desenvolvedores que estiverem usando o componente permitem a ajuda em tempo de execução.Em alguns casos, o entanto, faz sentido permitir que o componente para exibir ajuda HTML enquanto chamada.Ajuda HTML pode ser fornecida para componentes através do objeto de System.Windows.Forms.Help .Este objeto é um classe estática que encapsula ajuda HTML 1. mecanismos dex .Esta classe não pode ser instanciada, e seus métodos devem ser chamados diretamente.Para exibir a ajuda, chamar o método de método de Help.ShowHelp .Este método sobrecarregado requer pelo menos dois argumentos: o controle que atua como o controle pai da caixa de diálogo da ajuda, e o URL do arquivo de ajuda.O arquivo de ajuda pode ser compilado uma ajuda HTML 1. arquivos dex (arquivo .chm) ou um arquivo HTML no formato de ajuda HTML.
Se você irá inserir o suporte para um arquivo de ajuda diretamente no seu componente, você tem duas opções para quando e como mostrar o:
A opção preferencial é implementar um método da ajuda que pode ser chamado pelo aplicativo cliente.O aplicativo cliente pode passar parâmetros para o método da ajuda para garantir que os tópicos corretos são exibidos, e a codificação do desenvolvedor com seu componente tem a opção de ignorar a ajuda completamente.
Outra opção é chamar o método de ShowHelp em resposta a condições porque ocorrem no código.Essa abordagem fornece-lhe a mais controle sobre o que ajuda é exibida quando, mas limita fortemente os desenvolvedores futuros o uso do componente.
Para especificar uma e exibir ajuda arquivos para seu componente
Criar e compilar seu arquivo de ajuda .chm.
Se você ainda não tiver uma referência ao namespace de System.Windows.Forms no seu componente, adicione um.
Crie um método público para exibir a ajuda.Esse método deve fornecer uma maneira fácil para os desenvolvedores especifiquem que ajuda devem exibir.
' This method takes parameters from the client application that allow ' the developer to specify when Help is displayed. Public Sub DisplayHelp (ByVal parent as System.Windows.Forms.Control, _ ByVal topic as MyHelpEnum) ' The file to display is chosen by the value of the topic ' parameter. Select Case topic Case MyHelpEnum.enumWidgets Windows.Forms.Help.ShowHelp(parent, "C:\Help\Widgets.chm") Case MyHelpEnum.enumMechanisms ' Insert code to implement additional functionality. End Select End Sub// This method takes parameters from the client application that allow // the developer to specify when Help is to be shown. public void MyHelp(System.Windows.Forms.Control parent, myHelpEnum topic) { // The file to display is chosen by the value of the topic. switch (topic) { case myHelpEnum.enumWidgets: System.Windows.Forms.Help.ShowHelp(parent, " C:\\help\\widgets.chm "); break; case myHelpEnum.enumMechanism: // Insert code to implement additional functionality. break; } }