Практическое руководство. Предоставление справки в приложении Windows

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

Note

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

Предоставление справки

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

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

  2. В свойства окне HelpNamespace свойства к файлу справки, CHM, формате или .htm.

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

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

  4. В свойства окне SetHelpNavigator свойство в значение 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-страницы.

Important

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

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

См. также