Como: Especifique um arquivo de ajuda para seu componente
Na maioria das situações, você deve permitir que os desenvolvedores que utilizam o seu componente ativar a Ajuda em time de execução.Em alguns casos, no entanto, ele será fazer sentido permitir seu componente Exibir a Ajuda de HTML quando chamado.Ajuda em HTML pode ser fornecida para componentes por meio de System.Windows.Forms.Help objeto. Este objeto é uma classe estática que encapsula o HTML Help 1. x mecanismo.Esta classe não pode ser instanciada e seus métodos devem ser chamados diretamente.Para exibir a Ajuda, invocar o Método Help.ShowHelp método.Esse método sobrecarregado requer pelo menos dois argumentos: o controle que atua sistema autônomo o controle pai da caixa de diálogo Ajuda e a URL do arquivo de Ajuda.O arquivo de Ajuda pode ser de um 1 de ajuda de HTML compilado. x arquivo (.chm) ou um arquivo HTML no formato de Ajuda em HTML.
Se você for para incorporar o suporte a um arquivo de ajuda diretamente no componente, você tem duas opções para quando e como mostrá-lo:
A opção preferencial é implementar um método de ajuda que pode ser chamado pelo aplicativo cliente.O aplicativo cliente pode passar parâmetros para o método de ajuda para garantir que os tópicos corretos são exibidos e o desenvolvedor de codificação com o componente tem a opção de ignorar ajuda completamente.
A Outros opção é invocar o ShowHelp método em resposta a condições sistema autônomo que ocorrem no código. Essa abordagem oferece a você que mais controle sobre o qual ajuda é exibido quando, mas ele gravemente limita os desenvolvedores de futuros o uso de seu componente.
Para especificar e exibir um arquivo de ajuda para seu componente
Criar e compilar o arquivo .chm da Ajuda.
Se você ainda não tiver uma referência para o System.Windows.Forms espaço para nome em seu componente, adicione uma.
Crie um método público para mostrar Ajuda.Esse método deve fornecer uma maneira fácil para desenvolvedores para especificar quais ajuda precisam 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; } }