Практическое руководство. Предоставление справки в приложении Windows
компонент можно использовать HelpProvider для присоединения разделов справки в файле справки к конкретным элементам управления на Windows Forms. Файл справки может быть в формате HTML, HTMLHelp 1.x или следующих версий.
Предоставление справки
в Visual Studio из области элементов перетащите HelpProvider компонент в форму.
Компонент разместится в нижней части конструктора Windows Forms.
Выберите другой элемент управления в форме, а затем в окне Свойства задайте SetHelpKeyword свойство.
Это строка, передаваемая HelpProvider компонентом в файл справки для вызовите соответствующего раздела справки.
В окне Свойства задайте SetHelpNavigator для свойства значение HelpNavigator перечисления.
Этот параметр определяет способ, которым свойство HelpKeyword передается в справочную систему. В следующей таблице показаны возможные настройки и их описания.
| Имя элемента | Описание |
|---|---|
| AssociateIndex | Указывает, что индекс для данного раздела выполняется в заданном URL-адресе. |
| Поиск | Указывает, что отображается страница поиска заданного URL-адреса. |
| Индекс | Указывает, что отображается индекс заданного URL-адреса. |
| KeywordIndex | Указывает ключевое слово для поиска и действие, выполняемое по указанному URL-адресу. |
| TableOfContents | Указывает, что отображается оглавление файла справки HTML 1.0. |
| Раздел | Указывает, что отображается раздел, на который ссылается указанный URL-адрес. |
В настоящее время свойство HelpNamespace поддерживает файлы справки в следующих трех форматах: HTMLHelp 1.x, HTMLHelp 2.0 и HTML. Таким образом, свойству HelpNamespace можно присвоить http:// адрес, например веб-страницу. Если это будет сделано, откроется браузер по умолчанию для веб-страницы со строкой, указанной в свойстве HelpKeyword, которая используется в качестве привязки. Привязка используется для перехода к определенной части HTML-страницы.
Обязательно проверьте все сведения, отправляемые с клиента, перед их использованием в приложении. Злоумышленники могут попытаться послать или вставить исполняемый сценарий, инструкции SQL или другой код. Перед отображением ввода пользователя, сохранением его в базе данных или работой с ним убедитесь, что он не содержит потенциально небезопасных сведений. Например, можно порекомендовать использование регулярного выражения для поиска ключевых слов, таких как SCRIPT, при получении данных от пользователя.
можно также использовать HelpProvider компонент для отображения всплывающей справки, даже если она настроена для отображения файлов справки для элементов управления на Windows Forms. Дополнительные сведения см. в разделе Практическое руководство. Отображение всплывающей справки.
Введение
Установка Dr.Explain
Вы можете скачать установочный файл программы Dr.Explain на официальном сайте по адресу http://www.drexplain.ru/. Для этого воспользуйтесь кнопкой «Скачать бесплатно». После того как файл будет загружен запустите его. Для установки программы пройдите стандартную процедуру, следуя указаниям мастера (Рисунок 1). При использовании пробной версии Dr.Explain доступны все функции, но все изображения в экспортированных файлах помечаются водяными знаками.
Рисунок 1. Мастер установки «Dr.Explain»
Создание и настройка нового проекта
Рисунок 2. Окно «Проекты Dr.Explain»
Создание тематических разделов в файле справки
Рисунок 3. Дерево проекта «Dr.Explain»
Настройте порядок следования разделов в структуре документа с помощью пунктов «Выше» и «Ниже» контекстного меню. Изменить названия тем можно с помощью пункта «Переименовать».
Далее создайте содержимое разделов, выберите интересующий пункт в дереве проекта и приступайте к заполнению в окне редактора. Заполняйте раздел в свободной форме. В редакторе предусмотрены основные стандартные функции редактирования и форматирования текста и ряд функция для работы с изображениями, видео, таблицами и переменными. Использование переменных позволяет заменить повторяющиеся данные именем переменной. В таком случае при изменении присвоенного переменной значения, соответствующий текст изменится во всем документе.
Для повышения удобства поиска по файлу справки создайте и настройте ключевые слова. Откройте окно ключевых слов — кнопка «Ключевые слова» (Рисунок 4). Для добавления и удаления слов служат одноименные кнопки. Настройте привязку тем к словам, для этого выбрав интересующий раздел в структуре проекта, проставьте метки в полях тех терминов, которые хотите ассоциировать с данной темой.
Рисунок 4. Ключевые слова
Рисунок 5. Окно «Захват объекта»
Рисунок 6. Результат выполнения захвата объекта
Настройка значений Help ID
Рисунок 7. Изменение значения Help ID в окне «Свойства страницы»
Для проверки уникальности идентификаторов разделов используйте пункт «Инструменты –> Проверка проекта на ошибки» главного меню. Если в документе будут обнаружены повторяющиеся значения Help ID, в открывшемся окне появится сообщение с указанием повторяющихся значений. Устраните дублирования для правильной работы вызова разделов справки.
Предварительный просмотр и сохранение проекта
Перед экспортом проекта используйте функцию предварительного просмотра — кнопка «Просмотр CHM», чтобы убедиться в корректном отображении всех разделов справки. Если необходимо внести изменения, вернитесь в режим редактирования.
Экспорт проекта в CHM-файл
Рисунок 8. Окно «Экспорт в CHM»
Рисунок 9. Редактор форм среды разработки Microsoft Visual Studio
Рисунок 10. Редактор кода среды разработки Microsoft Visual Studio
При таком способе вызова файла справки при любых его перемещениях необходимо заново указывать в коде полный путь.
Будьте внимательны, для обеспечения правильной работы элемента вызова файла справки строго соблюдайте синтаксис, приведенный в примерах.
ОБРАТИТЕ ВНИМАНИЕ: Допускается использование нескольких компонентов «Help Provider». Это удобно в том случае, когда информация о различных элементах содержится в различных файлах справки. Также вы можете использовать отдельные компоненты для различных форм;
ОБРАТИТЕ ВНИМАНИЕ: Если файл справки располагается в одной папке с исполнительным файлом приложения, то достаточно указать только имя файла. При раздельного размещении файлов необходимо указать полный путь. В таком случае при любом перемещении файла справки, значение параметра «HelpNamespace» должно быть заменено актуальным.
ОБРАТИТЕ ВНИМАНИЕ: Количество параметров «HelpKeyword …» и «Help Provider…» в свойствах объектов соответствует количеству используемых компонентов «Help Provider», а цифра в наименовании параметра соответствует номеру компонента. Будьте внимательны при заполнении данных полей;
Открытие определенных разделов файла справки с помощью компонента Help Provider
Помимо вызова определенных разделов файла справки по соответствующим им HelpID, компонент «HelpProvider» также может быть использован для адресации разделов с использованием других параметров. Для настройки вызова определенных разделов необходимо установить соответствующие значения полей «HelpKeyword on Help Provider1» и «Help Navigator on Help Provider1» в свойствах элементов. Для настройки вывода определенных разделов файла справки при нажатии клавиши «F1» проделайте следующие действия:
·AssociateIndex— открывает вкладку «Указатель» иподсвечивает в списке первое по порядку ключевое слово, название которого начинается с сочетания символов в поле «HelpKeyword on Help Provider1»;
·Index — открывает вкладку «Указатель» и подсвечивает в спискеключевое слово, указанное в поле «HelpKeyword on Help Provider1»;
·Find — открывает вкладку «Поиск»;
·TableOfContents — открывает оглавление;
·Topic — открывает раздел, название которого указано в поле «HelpKeyword on Help Provider1».
ОБРАТИТЕ ВНИМАНИЕ: Название раздела указывается в формате «Topic.htm», это необходимо для правильной работы вызова справки.
·TopicId — открываетраздел,которому соответствует параметр Help ID, указанный в поле «HelpKeyword on Help Provider1»;
·KeywordIndex — открывает вкладку «Указатель» и выводит список разделов, содержащих ключевое слово, указанное в поле «HelpKeyword on Help Provider1».
Такой способ вызова справки позволяет гибко настроить адресацию и поиск в справочной системе, а также использовать для каждой отдельной формы или элемента соответствующий им файл справки или отдельные его разделы.
Если необходимо вызвать определенный раздел справочной системы с помощью кнопки, используйте следующие фрагменты кода:
Код вызова стартовой страницы справки:
где help.chm — имя файла справки (файл справки должен быть размещен в одной папке с исполнительным файлом приложения).
Код вызова вкладки «Указатель»:
Код вызова оглавления:
Код вызова вкладки «Поиск»:
Код вызова поиска по первым буквам ключевого слова:
где me — сочетание букв для поиска
Код вызова поиска по ключевому слову:
где FAQ — ключевое слово
Код вызова раздела по его названию:
где Overview.htm — название раздела (ключевое слово всегда указывается в формате Topic.htm)
Код вызова раздела по его HelpID:
где 1500 — значение HelpID интересующего раздела
Код вызова списка разделов, содержащих ключевое слово:
где menu — ключевое слово для поиска разделов.