Подключение справочной системы к проекту
Для подключения справочной системы к проекту необходим элемент HelpProvider. Для связывания разделов справки с элементом управления используются свойство HelpNamespace, которое позволяет задать имя файла справки. Поддерживаются скомпилированные файлы справки с расширением chm и файлы html.
Далее необходимо задать значения свойств HelpKeyword on HelpProvider и HelpNavigator on HelpProvider для тех элементов управления, для которых необходимо вызывать справку. В качестве значения свойства HelpKeyword могут использоваться имена html файлов, входящих в состав chm файла.
Свойство HelpNavigator задает константы, показывающие, какие элементы файла справки необходимо отображать. Возможные значения:
| Значение | Описание |
| AssociateIndex | Выполнение индекса для указанного раздела справки |
| Find | Отображение страницы поиска |
| Index | Отображение индекса |
| KeywordIndex | Задает зарезервированное слово для поиска |
| TableOfContents | Отображение оглавления |
| Topic | Отображение раздела справки |
Visual Basic .NET позволяет использовать контекстно-зависимую справку. Например, можно назначить разные разделы справки различным элементам управления. Для вызова справочной системы для активного элемента управления используется клавиша F1.
Методы HelpProvider:
| Метод | Описание |
| SetHelpNavigator | Задает тип предоставляемой справки |
| SetHelpKeyword | Задает зарезервированное слово или раздел для справки |
| GetHelpKeyword | Получает зарезервированное слово справки для элемента управления |
| GetHelpString | Получает содержимое всплывающего окна справки для элемента управления |
Если не задано свойство HelpNamespace, для предоставления текста справки можно использовать метод SetHelpString. Если одновременно заданы HelpNamespace и строка справки, то в первую очередь используется справка, основанная на HelpNamespace.
Метод SetHelpString используется для связывания определенной строки справки с элементом управления. Строка справки отображается во всплывающем окне при нажатии клавиши F1 в момент, когда фокус находится на элементе управления.
Перед запуском программы необходимо скопировать файл справки в каталог приложения, где находится exe файл.
Создание собственных файлов справки
Существует специальный инструмент Visual Studio .NET Help Integration Kit 2003, после установки которого в диалоговом окне Visual Studio .NET New Project появляется новая категория проектов Help Projects, которая предоставляет шаблоны для проектов справки.
Проект справочной системы имеет расширение .HWProj. В состав проекта входят файлы следующего типа:
| Расширение | Описание |
| HxS | Скомпилированный файл справки |
| НхС | Файл набора |
| HxF | Файл включений |
| НхТ | Файл содержания |
| НхК | Файл указателя |
| НхА | Файл атрибутов |
| НхЕ | Файл определения примера |
| html, htm, txt и пр. | Файлы тематических разделов и содержимого справки |
При создании нового проекта работа начинается с двух файлов: файла набора и файла включений. Редактирование этих файлов возможно через диалоговое окно Property Pages проекта.
Обычно требуется добавить минимум один файл содержания и один файл указатель.
В содержание можно вносить файлы с содержимым, ссылки на внешние Web-сайты и элементы файловой системы.
Чтобы при открытии файла справки отображалась начальная страница, надо в файле указателя написать следующий код:
<Keyword Term ="HomePage">
<Jump Url ="HomePage.html>
</Keyword>
После компиляции проекта создается HxS-файл.
Технология Microsoft HTML Help
Инструмент Microsoft HTML Help Workshop, входящий в поставку Visual Studio.NET используется для создания справочной системы в формате HTML.
Мастер создания проекта позволяет легко и быстро создать справочную систему, в том числе файлы разделов справки, содержания, алфавитного указателя
Результатом работы компилятора будет файл с расширением .chm.
| < Предыдущая | Следующая > |
|---|