Como: Exibir Ajuda do usuário

Artigo
08/25/2010

O .NET Compact Framework fornece acesso ao programa de Ajuda do Windows CE, peghelp.exe, para exibir tópicos da Ajuda para aplicativos Pocket PC.Você pode exibir um tópico da Ajuda com o ShowHelp método do Windows Forms Help respondendo a classe a HelpRequested evento e uso HelpEventArgs. O .NET Compact estrutura não dá suporte a HelpNavigator enumeração ou HelpProvider classe.

Tópicos da Ajuda podem estar localizados em um ou mais arquivos .htm.Não há suporte para HTML compilado ou arquivos .chm, no Pocket PC.The HelpRequested evento é recebido pelo formulário atualmente ativo quando o usuário navega para o Iniciar menu e escolhe Ajuda.O evento não é deflagrado pelos controles no formulário.

Ajuda não está integrado ao sistema operacional do Smartphone pois os aplicativos do Smartphone devem ser simples.

A tabela a seguir lista os recursos de Ajuda do sistema exibidos para cada tópico.

Item do menu	Função
View	Fornece acesso ao comando Contents que exibe o primeiro nível do conteúdo para o arquivo de Ajuda atual, e o comando All Installed Help que exibe uma lista de todos os arquivos da Ajuda instalados.
Back	Exibe o tópico visualizado anteriormente na sessão atual.
encaminhar	Exibe o próximo tópico na lista de histórico.
Localizar	Abre a caixa de diálogo Find para procurar tópicos da Ajuda por palavras-chave.Você pode especificar palavras-chave nos arquivos .htm.

Os procedimentos a seguir mostram como fazer o seguinte:

Criar um arquivo .htm de tópicos da Ajuda
Exibir Ajuda para seu aplicativo
Instalar o arquivo da Ajuda no dispositivo

Para criar um arquivo .htm dos tópicos da Ajuda

Crie um arquivo de texto denominado para a Ajuda com uma extensão .htm.Este procedimento cria Ajuda para um jogo, chamado Critters, como exemplo.O arquivo deve ter a marca META no cabeçalho da seguinte forma:
```
<HTML>
<HEAD>
<META HTTP-EQUIV="Htm-Help" Content="Critters.htm#main_contents">
```
O primeiro tópico em cada arquivo de Ajuda deve ser denominado " main_contents ".

Adicione palavras-chave para o programa Find.Separe palavras-chave com ponto-e-vírgula.Adicionar marcas adicionais de palavra-chave para vincular a tópicos específicos conforme necessário.

<KEYWORD VALUE="Critters;Games" TITLE="Critters Help" 
  HREF="Critters.htm#main_contents">
<KEYWORD VALUE="Critters overview" TITLE="Critters Help" 
  HREF="Critters.htm#overview">
<KEYWORD VALUE="Critters options" TITLE="Critters Help" 
  HREF="Critters.htm#options">

Não há limite máximo de palavra-chave para um tópico.

Crie o tópico main_contents.Cada tópico, incluindo main_contents, deve ser precedido pela seguinte marca de comentário:
```

```
O tópico main_contents normalmente contém links para subtópicos.Observe que links requerem o nome do arquivo além do nome de âncora.
```
</head>
<body>

<a name="Main_Contents"></a>
Critters Help

<a href="critters.htm#overview">Game Overview</a> 
<a href="critters.htm#options">Options</a> 
```
Você pode adicionar gráficos, mas somente bitmaps que devem ser renomeados para ter uma extensão " 2pb ".
```
<img src="critter.2bp">
```
Crie tópicos adicionais.

O código seguinte é um exemplo do HTML entre dois tópicos:
```



<hr>
<a name="overview">
```
Salve o arquivo e copie o para o diretório do Windows do Pocket PC.

O HTML completo para este exemplo é o seguinte:

<html>
<head>
<META HTTP-EQUIV="Htm-Help" Content="critters.htm#Main_Contents">
<KEYWORD VALUE="Critters;Games" TITLE="Critters Help" 
  HREF="Critters.htm#main_contents">
<KEYWORD VALUE="Critters overview" TITLE="Critters Help" 
  HREF="Critters.htm#overview">
<KEYWORD VALUE="Critters options" TITLE="Critters Help" 
  HREF="Critters.htm#options">
</head>
<body>
<!-- PegHelp -->
<p>
<a name="Main_Contents"></a>
</p>
<b>Critters Help</b>
</p>
<p>
<a href="critters.htm#overview">Game Overview</a><br>
<a href="critters.htm#options">Game Options</a><br>
<img src="critter.2bp">
</p>
<!-- PegHelp -->
<!-- ******* TOPIC BREAK ******* -->
<hr>
<a name="overview"></a>
<p><b>Game Overview</b></p>
<p>Critters are small round creatures that you can adopt and raise.  
  They have various moods and characteristics and each one has its own 
  personality and appearance that will change over time.</p>
<!-- PegHelp -->
<!-- ******* TOPIC BREAK ******* -->
<hr>
<a name="options"></a>
<p><b>Options</b></p>
<ul>
<li><i>Sound</i> – Turn sound on / off</li>
<li><i>Sub-Games</i> – Turn sub-games on / off.  When a caretaker 
  attempts to play with a critter or teach a critter, sub-games are 
  presented such as ‘Guess my number’ and ‘Trivia’ if this option is 
  checked.</li>
<li><i>Animation</i> – Turn animation on / off.  Turning this off will 
  cause the critter to remain still.</li>
<li><i>Notifications</i> – Choose icon / text / none.  Notifications 
  appear to inform you when your critter is in danger of dying due to 
  a particular need not being met.</li>
<li><i>Speed</i> – This is the rate at which the game engine operates.
  It affects how fast feelings develop and statistics are 
  modified.</li>
</ul>
</p>
</body>
</html>

Observação:
Ao trabalhar com arquivos de Ajuda, a p revious versão da sua ajuda pode estar no cache impedindo de ver as atualizações mais recentes.Para atualizar, exiba um tópico da Ajuda diferente daquele em que estiver trabalhando, e em seguida exiba a Ajuda novamente.

Para exibir Ajuda para seu aplicativo

Para exibir a Ajuda no Pocket PC, selecione o comando Help no menu Start.Windows CE exibe o tópico da Ajuda para o aplicativo atualmente exibido, desde que você tenha chamado o ShowHelp método em resposta à HelpRequested evento.

Você também pode usar ShowHelp para chamar Ajuda de dentro de seu aplicativo, tais sistema autônomo de um botão de clicar. O exemplo de código a seguir mostra como chamar Ajuda para ambos os casos.Observe que o primeiro parâmetro para o ShowHelp método é o controle pai. Este parâmetro não é relevante para o Pocket PC mas é fornecida para compatibilidade com o .NET Framework completo.

Protected Overrides Sub OnHelpRequested(ByVal hlpevent As HelpEventArgs) 
    ' The HelpRequested event occurs when
    ' the user taps Help on the Start menu.
    Help.ShowHelp(Me, "\windows\myAppHelp.htm#Main_Contents")
    MyBase.OnHelpRequested(hlpevent)

End Sub
Private Sub button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles button1.Click
    ' You can also show Help
    ' for a subtopic
    ' by clicking a button.
    Try
        Help.ShowHelp(Me, "\windows\myappHelp.htm#overview")
    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
End Sub

protected override void OnHelpRequested(HelpEventArgs hlpevent)
{
    // The HelpRequested event occurs when
    // the user taps Help on the Start menu.
    Help.ShowHelp(this,@"\windows\myAppHelp.htm#Main_Contents");
    base.OnHelpRequested(hlpevent);
}

private void button1_Click(object sender, System.EventArgs e)
{
    // You can also show Help
    // for a subtopic
    // by clicking a button.
    try
    {
        Help.ShowHelp(this,@"\windows\myappHelp.htm#overview");
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

Para instalar seu arquivo de ajuda no dispositivo

Crie um arquivo de atalho para o sistema de Ajuda para listar sua Ajuda com as outras Ajudas instaladas no sistema.Em um editor de texto, crie um arquivo com um caminho para sua Ajuda usando a seguinte sintaxe:
```
14#\windows\critters.htm
```
O caminho é precedido pelo número de caracteres no caminho e o sinal numérico (#).Isso deve ser a única linha no arquivo.No exemplo, a Ajuda para o jogo Critters é exibida.
Salve o arquivo usando o mesmo nome que sua Ajuda mas com uma extensão .lnk na pasta \Windows\Help.
Selecione Help a partir do menu Start.Se a Ajuda não for exibida, escolha All Installed Help no menu View.A Ajuda deve ser incluída em ordem alfabética na lista.

Compartilhar via

Como: Exibir Ajuda do usuário

Para criar um arquivo .htm dos tópicos da Ajuda

Para exibir Ajuda para seu aplicativo

Para instalar seu arquivo de ajuda no dispositivo

Consulte também

Conceitos

Outros recursos

Recursos adicionais