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

Общие сведения о компоненте HelpProvider (Windows Forms)

  • Статья

Компонент HelpProvider в Windows Forms позволяет связать HTML-файл справки версии 1.x (CHM-файл, созданный с помощью средства HTML Help Workshop, или HTM-файл) с приложением Windows. Вы можете предоставить справку различными способами:

  • Предоставление контекстной справки по элементам управления в Windows Forms.

  • Предоставление контекстной справки для определенного диалогового окна или определенных элементов управления в диалоговом окне.

  • Открытие файла справки для определенных областей, таких как главная страница оглавления, индекс или функция поиска.

Использование поставщика справки

Добавление компонента HelpProvider в форму Windows позволяет другим элементам управления в форме предоставлять свойства справки по компоненту HelpProvider. Это позволяет предоставить справку по элементам управления в Windows Forms. Файл справки можно связать с компонентом HelpProvider с помощью свойства HelpNamespace. Вы указываете тип справки, предоставляемой путем вызова SetHelpNavigator и предоставления значения из перечисления HelpNavigator для указанного элемента управления. Вы предоставляете ключевое слово или раздел справки путем вызова метода SetHelpKeyword.

При необходимости, чтобы связать определенную строку справки с другим элементом управления, используйте метод SetHelpString. Строка, связанная с элементом управления с помощью этого метода, отображается во всплывающем окне, когда пользователь нажимает клавишу F1 при нахождении элемента управления в фокусе.

Если параметр HelpNamespace не задан, необходимо указать текст справки с помощью SetHelpString. Если заданы и HelpNamespace, и строка справки, приоритет имеет справка на основе HelpNamespace.

Примечание.

При указании пути к файлу справки в методе ShowHelp или свойстве HelpNamespace элемента управления HelpProvider могут возникнуть проблемы с использованием относительного пути. Поэтому обязательно используйте абсолютный путь к файлу справки.

См. также