Como fornecer ajuda contextual ou a Ajuda on-line em um aplicativo do Windows usando o Visual Basic

IMPORTANTE: Este artigo foi traduzido por um sistema de tradução automática (também designado por Machine Translation ou MT), não tendo sido portanto traduzido ou revisto por pessoas. A Microsoft possui artigos traduzidos por aplicações (MT) e artigos traduzidos por tradutores profissionais, com o objetivo de oferecer em português a totalidade dos artigos existentes na base de dados de suporte. No entanto, a tradução automática não é sempre perfeita, podendo conter erros de vocabulário, sintaxe ou gramática. A Microsoft não é responsável por incoerências, erros ou prejuízos ocorridos em decorrência da utilização dos artigos MT por parte dos nossos clientes. A Microsoft realiza atualizações freqüentes ao software de tradução automática (MT). Obrigado.

Clique aqui para ver a versão em Inglês deste artigo: 821777
Sumário
Este artigo passo a passo descreve como fornecer páginas de Ajuda on-line e ajuda contextual para os controles em um aplicativo do Microsoft Windows. O exemplo usa a classe HelpProvider e a classe Ajuda para fornecer ajuda para os controles no aplicativo.

Requisitos

A lista a seguir descreve o hardware recomendado, software, infra-estrutura de rede e service packs que você precisa:
  • Microsoft Visual Studio 2005 ou o Microsoft Visual Studio .NET
  • Conectividade com A Internet
Este artigo pressupõe que você esteja familiarizado com os seguintes tópicos:
  • Programação do Microsoft Visual Basic 2005 ou Microsoft Visual Basic .NET

Sobre a classe HelpProvider

A classe HelpProvider fornece ajuda contextual ou páginas de Ajuda on-line para controles. Cada instância de HelpProvider mantém uma coleção de referências aos controles que estão associados com a instância. Para fornecer páginas de Ajuda on-line para o controle, defina a propriedade HelpNamespace HelpProvider e, em seguida, associar um arquivo de ajuda ao objeto HelpProvider .

Você pode especificar o tipo de Ajuda que o aplicativo fornece para o controle chamando o método SetHelpNavigator e fornecendo um valor HelpNavigator para o controle especificado. HelpProvider de Ajuda e usam a enumeração HelpNavigator para fornecer acesso aos elementos especificados do arquivo de Ajuda. Os membros do HelpNavigator são as seguintes:
  • AssociateIndex
  • Localizar
  • índice
  • KeywordIndex
  • TableOfContents
  • tópico
Você fornece a palavra-chave ou tópico para o arquivo de Ajuda, chamando o método SetHelpKeyword . Você usa o método SetHelpString de HelpProvider para associar uma seqüência de ajuda específica um controle. A seqüência que você associar um controle usando SetHelpString método aparece em uma janela pop-up quando você pressiona F1 enquanto o controle tem foco.

Quando HelpNamespace não está definida, use SetHelpString para fornecer o texto de Ajuda. Quando você definir HelpNamespace e a seqüência de Ajuda, a Ajuda que se baseia HelpNamespace terá precedência.

Sobre a classe ajuda

A classe Ajuda fornece ajuda para um aplicativo chamando o método ShowHelp estático e o método estático ShowHelpIndex . O método ShowHelp exibe o conteúdo de um arquivo de Ajuda. O método ShowHelpIndex exibe o índice do arquivo de Ajuda especificado. Você pode usar o objeto Ajuda para exibir arquivos de ajuda como o módulo de Ajuda compilado (.chm) arquivos ou arquivos HTML que estão no formato Ajuda em HTML.

Usar a classe HelpProvider para fornecer Ajuda on-line para controles

O exemplo a seguir descreve como usar a classe HelpProvider para exibir o conteúdo do arquivo Ajuda contextual para um formulário que contém controles.

Defina a propriedade HelpNamespace da classe HelpProvider para um arquivo HTML ou para um arquivo .chm. Para fazer isso, execute as seguintes etapas:
  1. Inicie Microsoft Visual Studio .NET ou Microsoft Visual Studio 2005.
  2. No menu arquivo , aponte para novo e, em seguida, clique em Project .
  3. Em Project Types , clique em Projetos do Visual Basic . Em modelos , clique em Windows Application e, em seguida, clique em OK . Por padrão, um formulário que é denominado Form1 é criado.

    Observação No Visual Studio 2005, clique em Visual Basic em Project Types .
  4. Adicione um componente HelpProvider ao formulário Form1.
  5. Clique com o botão direito do mouse HelpProvider1 e, em seguida, clique em Propriedades .
  6. Na caixa de diálogo Propriedades , defina a propriedade HelpNamespace para http://msdn.microsoft.com/library/en-us/vbcon/html/vbconbuttoncontroloverview.asp .
  7. Adicione um controle Button ao formulário Form1. Button1 é criado.
  8. Na caixa de diálogo Propriedades de Button1 , defina ShowHelp em HelpProvider1 como True .
  9. Defina a propriedade Text de Button1 para Enviar .

Usar a classe HelpProvider para fornecer ajuda contextual para controles

O exemplo a seguir descreve como usar a classe HelpProvider para exibir ajuda para os controles em uma janela pop-up. Use o método SetHelpString da classe HelpProvider para definir a dica de ferramenta ajuda texto para os controles. Quando você clique no botão Ajuda na barra de título do formulário Form1 e em seguida, clique no controle, a seqüência de Ajuda será exibida.
  1. Adicione dois controles TextBox ao formulário Form1.
  2. Adicione o seguinte código de exemplo para Form1_Load manipulador de eventos.
    'Set the Help string for the TextBox control on the form.HelpProvider1.SetHelpString(Me.TextBox1, "Enter your UserName")HelpProvider1.SetHelpString(Me.TextBox2, "Enter your Password in this TextBox")'Set the Help string for the Button control on the form.HelpProvider1.SetHelpString(Me.Button1, "Click submit after you type your UserName and Password")
  3. Clique com o botão direito do mouse no Form1 e, em seguida, clique em Propriedades .
  4. Na caixa de diálogo Propriedades , defina HelpButton como True .
  5. Definir MaximizeBox como False .
  6. Definir MinimizeBox como False .

Use o método SetHelpNavigator para fornecer um tipo especificado de Ajuda

O exemplo a seguir descreve como usar o método SetHelpNavigator para recuperar o índice analítico do arquivo Notepad.chm Ajuda.
  1. Adicione um componente HelpProvider ao formulário Form1.
  2. Clique com o botão direito do mouse HelpProvider2 e, em seguida, clique em Propriedades .
  3. Na caixa de diálogo Propriedades , defina a propriedade HelpNamespace HelpProvider2 para o caminho do arquivo Notepad.chm que está no seu computador. Por exemplo, defina o caminho para C:\WINDOWS\Help\Notepad.chm .
  4. Adicione um controle Button ao formulário Form1.
  5. Na caixa de diálogo Propriedades , defina a propriedade texto de Button2 para Salvar UserName no bloco de notas .
  6. Defina a propriedade ShowHelp em HelpProvider2 do Button2 como True .
  7. Adicione a instrução a seguir na parte superior do código do formulário Form1.
    Imports System.IO
  8. Adicione o código de exemplo a seguir ao manipulador de evento Button2_Click .
    Dim path As String = "c:\temp\MyTest.txt"Dim sw As StreamWriter' This text is added to the file only one time.If File.Exists(path) = False Then      ' Create a file to write to.      sw = File.CreateText(path)      'Write the UserName and the password to the text file.      sw.WriteLine(TextBox1.Text)      sw.WriteLine(TextBox2.Text)      sw.Flush()      sw.Close()End If
  9. Adicione o seguinte código de exemplo para Form1_Load manipulador de eventos.
    'Display the Table of Contents of the Help file when you press F1. HelpProvider2.SetHelpNavigator(Button2, HelpNavigator.TableOfContents)

Usar a classe de Ajuda para exibir um arquivo de Ajuda on-line para um controle

O exemplo a seguir descreve como usar o método ShowHelp da classe Ajuda para exibir o arquivo de Ajuda para o controle ListBox. Se o controle tiver foco, o arquivo de Ajuda será exibido quando você pressiona F1.
  1. Adicione um controle ListBox ao formulário Form1.
  2. Clique com o botão direito do mouse em ListBox1 e, em seguida, clique em Propriedades .
  3. Na caixa de diálogo Propriedades , clique na propriedade itens e, em seguida, clique o botão de reticências (... ).
  4. Na caixa de diálogo String Collection Editor , digite as seguintes seqüências:
    • domínio1
    • Domain2
    • Domain3
  5. Clique em OK .
  6. Adicione o código de exemplo a seguir ao manipulador de evento ListBox1_KeyDown .
     If e.KeyCode = Keys.F1 Then       'Display the Help file for the ListBox control when you press F1.       Help.ShowHelp(ListBox1, "http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vbcon/html/vboriListBoxControlProgramming.asp")End If

Verificar se ele funciona

  1. No menu Build , clique em Build Solution .
  2. No menu Debug , clique em Iniciar .
  3. Clique em Ajuda (? ) na barra de ferramentas do formulário Form1 e clique em qualquer um dos seguintes controles:
    • TextBox1
    • TextBox2
    • Enviar
    A Ajuda contextual para o controle aparece.
  4. Quando o botão Enviar tiver foco, pressione F1. O arquivo de Ajuda para o controle Enviar aparece.
  5. Quando o controle ListBox1 tiver foco, pressione F1. O arquivo de Ajuda para o controle ListBox1 aparece.
  6. Quando o botão Salvar UserName no bloco de notas tem foco, pressione F1. O arquivo de Ajuda para o bloco de notas aparece.
Referências
Para obter mais informações, visite os seguintes sites da Microsoft Developer Network (MSDN):

Aviso: este artigo foi traduzido automaticamente

Propriedades

ID do Artigo: 821777 - Última Revisão: 11/26/2007 07:02:04 - Revisão: 2.6

Microsoft Visual Studio 2005 Standard Edition, Microsoft Visual Studio 2005 Professional Edition, Microsoft Visual Studio .NET 2003 Professional Edition, Microsoft Visual Studio .NET 2003 Enterprise Architect, Microsoft Visual Studio .NET 2003 Enterprise Developer, Microsoft Visual Studio .NET 2003 Academic Edition, Microsoft Visual Studio .NET 2002 Professional Edition, Microsoft Visual Studio .NET 2002 Enterprise Architect, Microsoft Visual Studio .NET 2002 Enterprise Developer, Microsoft Visual Studio .NET 2002 Academic Edition, Microsoft Visual Basic 2005, Microsoft Visual Basic .NET 2003 Standard Edition, Microsoft Visual Basic .NET 2002 Standard Edition

  • kbmt kbvs2005applies kbvs2005swept kbhelpfile kbhelp kbhowtomaster kbhowto kbcontrol kbctrl kbforms kbwindowsforms KB821777 KbMtpt
Comentários