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


Как предоставить помощь в приложении Windows

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

Оказать помощь

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

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

  2. В окне свойств задайте для свойства HelpNamespace файл формата .chm, .col или справочный файл формата .htm.

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

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

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

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

    Имя участника Описание
    ИндексАссоциативности Указывает, что индекс указанного раздела выполняется в указанном URL-адресе.
    Поиск Указывает, что отображается страница поиска указанного URL-адреса.
    Индекс Указывает, что отображается индекс указанного URL-адреса.
    ИндексКлючевыхСлов Указывает ключевое слово для поиска и действия, выполняемого в указанном URL-адресе.
    Оглавление Указывает, что отображается оглавление файла справки HTML 1.0.
    Тема Указывает, что отображается раздел, на который ссылается указанный URL-адрес.

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

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

Это важно

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

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

См. также