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

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

• предоставить контекстную справку для элементов управления Windows Forms;

• предоставить контекстную справку для определенного диалогового окна или для определенных элементов управления диалогового окна;

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

Использование элемента управления HelpProvider

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

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

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

См. также

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

Справочные системы в приложениях Windows Forms