Share via

Руководство: предоставление справки в приложении Windows

  • Статья

Можно использовать компонент HelpProvider для присоединения разделов справки, содержащихся в файле справки, к определенным элементам управления в формах Windows Forms. Файл справки может быть в формате HTML или HTMLHelp 1.x или более поздней версии.

Примечание

Отображаемые диалоговые окна и команды меню могут отличаться от описанных в справке в зависимости от текущих настроек или выпуска.Чтобы изменить параметры, выберите в меню Сервис пункт Импорт и экспорт параметров.Дополнительные сведения см. в разделе Работа с параметрами.

Чтобы предоставить справку

  1. Перетащите компонент HelpProvider из панели элементов в форму.

    Компонент будет расположен в нижней части конструктора Windows Forms.

  2. В окне Свойства задайте установите свойству HelpNamespace значение в виде CHM-, COL- или HTM-файла справки.

  3. Выберите другой элемент управления в форме и задайте его свойство HelpKeyword в окне Свойства.

    Эта строка с помощью компонента HelpProvider передается в имеющийся файл справки для вызова соответствующего раздела справки.

  4. В окне Свойства присвойте свойству HelpNavigator значение перечисления HelpNavigator.

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

    Имя элемента

    Описание

    AssociateIndex

    Указывает, что индекс для данного раздела выполняется в заданном URL.

    Find

    Указывает, что отображается страница поиска заданного URL-адреса.

    Указатель

    Указывает, что отображается указатель заданного URL-адреса.

    KeywordIndex

    Указывает ключевое слово для поиска и действие для выполнения в заданном URL-адресе.

    TableOfContents

    Указывает, что отображается оглавление файла справки HTML 1.0.

    Раздел

    Указывает, что отображается раздел, на который ссылается заданный URL-адрес.

Во время выполнения нажатие клавиши F1 при находящемся в фокусе элементе управления (для которого заданы свойства HelpKeyword и HelpNavigator) открывает файл справки, связанный с компонентом HelpProvider.

В настоящее время свойство HelpNamespace поддерживает файлы справки в следующих трех форматах: HTMLHelp 1.x, HTMLHelp 2.0 и HTML. Поэтому свойству HelpNamespace можно задать адрес http:// (веб-страница). Если сделать это, то это свойство открывает обозреватель по умолчанию на веб-странице со строкой, указанной в свойстве HelpKeyword и использованной для привязки. Привязка используется для перехода к определенной части HTML-страницы.

Примечание о безопасностиПримечание по безопасности

Обязательно проверяйте любые сведения, посылаемые клиентом, перед их использованием в приложении.Злоумышленники могут попытаться послать или вставить исполняемый скрипт, инструкции SQL или другой код.Перед отображением данных, введенных пользователем, сохраните их в базе данных или проверьте, не содержат ли они потенциально небезопасные сведения.При обычном способе проверки при получении данных от пользователя используется регулярное выражение для поиска ключевых слов, таких как "SCRIPT" .

Следует помнить, что можно также использовать компонент HelpProvider для отображения всплывающей справки, даже если он настроен на отображение файлов справки для элементов управления Windows Forms. Дополнительные сведения см. в разделе Практическое руководство. Отображение всплывающей справки.

См. также

Задачи

Практическое руководство. Отображение всплывающей справки

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

Отображение справки по элементам управления с помощью всплывающих подсказок

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

Интеграция справки пользователя в формы Windows Forms

Windows Forms