IControl.HelpContext

Синтаксис

HelpContext: Integer;

Описание

Свойство HelpContext определяет уникальный индекс раздела контекстно-зависимой справки для данного компонента.

Комментарии

При создании файлов справки каждой странице может быть сопоставлен уникальный идентификатор. Он присваивается при создании карты идентификаторов (Map ID). При создании карты идентификаторов каждому идентификатору также будет соответствовать уникальный индекс. Именно этот индекс необходимо задать в свойстве HelpContext для сопоставления компоненту определенной страницы в справке. Более подробную информацию о создании карты идентификаторов можно узнать в руководстве по конкретному программному продукту, который используется для создания файла справки.

Страница справки с разделом, соответствующим указанному индексу, будет показана пользователю, если компонент находится в фокусе и нажата кнопка «F1» или была нажата кнопка-подсказка «?» после чего был осуществлен щелчок по компоненту. Кнопка-подсказка становится доступной после установки свойству BorderStyle значения DialogWithHelp. Эмулировать нажатие на данную кнопку можно методом EnterContextHelpMode.

Если HelpContext = 0, то компонент наследует значение HelpContext родителя (компонента, на котором он расположен, или формы). Например: если задано значение HelpContext для формы, то для всех компонентов формы, у которых HelpContext=0, будет показан раздел справки, соответствующий уникальному индексу, указанному для формы.

Дополнительное описание читайте в разделе Вопросы и ответы: Использование пользовательской справки.

См. также:

IControl