Пошаговое руководство. Отображение пользовательской справки

Статья
11/05/2008

Обновлен: Ноябрь 2007

Платформа .NET Compact Framework предоставляет доступ к программе справки Windows CE, peghelp.exe, отображающей разделы справки для приложений карманного ПК. Можно отобразить раздел справки с помощью метода ShowHelp класса Windows Forms Help, отвечающего на событие HelpRequested и использующего HelpEventArgs. Платформа .NET Compact Framework не поддерживает перечисление HelpNavigator или класс HelpProvider

Раздел справки может находиться в одном или более файлов .htm. Скомпилированные файлы HTML или .chm не поддерживаются в карманных ПК. Событие HelpRequested получает текущую активную форму, когда пользователь выбирает раздел меню Пуск и затем выбирает подраздел Справка. Событие не вызывается элементом управления формы.

Справка не интегрирована в операционную систему смартфона, поэтому приложения смартфона должны быть простыми.

В следующей таблице приведены возможности системной справки для каждого раздела.

Элемент меню	Функция
Вид	Предоставляет доступ к команде Содержимое, которая отображает первый уровень содержимого для текущего файла справки, и команде Вся справка, которая отображает список всех установленных файлов справки.
Назад	Отображает предыдущий просматривавшийся раздел в текущей сессии.
Далее	Открытие следующего раздела в списке "История".
Поиск	Открывает диалоговое окно Поиск для поиска раздела справки по ключевому слову. Ключевые слова можно задавать в файлах .htm.

В процедурах ниже показано, как сделать следующее:

Создание файла .htm разделов справки
Отображение справки для приложения
Установка файла справки на устройство

Чтобы создать файл .htm раздела справки

Создайте текстовый файл, имеющий в вашей справке расширение .htm. Эта процедура создаст справку для игры под названием "Существа" в качестве примера. Файл должен иметь в заголовке мета-тег как показано ниже:
```
<HTML>
<HEAD>
<META HTTP-EQUIV="Htm-Help" Content="Critters.htm#main_contents">
```
Первый раздел в файле справки следует назвать "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">
```
Количество ключевых слов для раздела не ограничено.
Создайте раздел main_contents. Каждому разделу, включая main_contents, должен предшествовать следующий тег комментария:
```

```
Раздел main_contents обычно содержит ссылки на подразделы. Обратите внимание, что требуется имя файла в дополнение к имени привязки.
```
</head>
<body>

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

<a href="critters.htm#overview">Game Overview</a> 
<a href="critters.htm#options">Options</a> 
```
Можно добавить графические элементы, но только растровые, и они должны быть переименованы, чтобы иметь расширение "2pb".
```
<img src="critter.2bp">
```
Создайте дополнительные разделы

Пример HTML-кода между двумя разделами:
```



<hr>
<a name="overview">
```
Сохраните файл и скопируйте его в директорию Windows карманного ПК.

Полный HTML-код для этого примера следующий:

<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>

Примечание.
При работе с файлами справки, предыдущая версия справки может содержаться в кэше, это может не давать возможности просматривать последние обновления. Для обновления отобразите раздел справки, отличный от того, с которым Вы сейчас работаете, а затем снова отобразите раздел справки, с которым Вы работали.

При работе с файлами справки, предыдущая версия справки может содержаться в кэше, это может не давать возможности просматривать последние обновления. Для обновления отобразите раздел справки, отличный от того, с которым Вы сейчас работаете, а затем снова отобразите раздел справки, с которым Вы работали.

Чтобы отобразить справку для вашего приложения

Чтобы отобразить справку на карманном ПК, нажмите команду Справка в меню Пуск. Windows CE отображает раздел справки для текущего отображаемого приложения, если был вызван метод ShowHelp в ответ на событие HelpRequested.

Можно также использовать ShowHelp для вызова справки из другого приложения, например, нажав кнопку. В следующем примере кода демонстрируется вызов справки для обоих случаев. Обратите внимание, что первый параметр для метода ShowHelp является родительским элементом управления. Этот параметр не имеет значения для карманного ПК, но он обеспечивает совместимость с полной версией платформы .NET Framework.

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);
    }
}

Чтобы установить файл справки на устройство.

Создайте ярлык для системной справки, чтобы создать список вашей и других установленных справок в системе. В текстовом редакторе создайте файл с путем к вашей справке, используя следующий синтаксис:
```
14#\windows\critters.htm
```
Путь предваряет количество символов в пути и знак (#). Файл должен содержать одну строку. В этом примере отображается справка для игры "Существа".
Сохраните файл, используя такое же имя файла, как и в вашей справке с расширением .lnk в папке \Windows\Help.
В меню Пуск выберите Справка. Если справка не отображается, выберите Вся справка из меню Вид. Ваша справка должна содержаться в списке в соответствии с алфавитом.

См. также

Основные понятия

Разделы руководства по платформе .NET Compact Framework

Другие ресурсы

Элементы управления Windows Forms, используемые в платформе .NET Compact Framework

Поделиться через