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

Номер статьи: KB000025

Описание

Для работы со справкой продукта «Форсайт. Аналитическая платформа» в классе WinApplication реализовано свойство Help. Данное свойство возвращает объект, используемый для управления справкой. Свойство FileName определяет путь и наименование файла справки, который будет вызываться. По умолчанию в данном свойстве содержится путь к файлу «Studio.chm». Данный файл устанавливается автоматически вместе с «Форсайт. Аналитическая платформа».

У всех компонентов, расположенных на форме, должно быть установлено свойство HelpContext. Для вызова справки на прикладных формах необходимо установить обработчик события OnHelp, возникающего если будет нажата кнопка F1 или кнопка-подсказка «?», когда какой-либо компонент находится в фокусе. В данном событии, используя свойство ContextId, можно получить индекс раздела справки (значение свойства HelpContext), связанного с компонентом, находящимся в фокусе. Передавая данное значение в метод Context осуществляется вызов соответствующего раздела справки.

Пример

Для выполнения примера предполагается наличие формы и расположенных на ней каких-либо компонентов. Для всех компонентов установлены уникальные значения свойства HelpContext. Для обработки события OnHelp формы установлена данная процедура. В папке приложения должен содержаться файл «Help.chm», имеющий настроенную карту идентификаторов.

Sub FormOnHelp(Sender: Object; Args: IHelpEventArgs);
Var
    Help: IWinApplicationHelp;
Begin
    Help := WinApplication.Help;
    Help.Context(Args.ContextId, "Help.chm");
End Sub FormOnHelp;

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

Замена справки для системных диалогов

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

Примечание. Для получения ключевых слов к требуемым диалогам обращайтесь в техническую поддержку по адресу support@fsight.ru или через сервисы технической поддержки, которые доступны после регистрации на сайте.

Для вызова пользовательской справки установите путь к пользовательскому файлу справки FileName. В файле для соответствующих разделов должны быть добавлены ключевые слова, которые используются в ядре платформы.

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

Пример

Для выполнения примера предполагается наличие формы и расположенной на ней кнопки с идентификатором «Button1».

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Begin
    WinApplication.Help.ALinkLookup("CUiDlgLogin");
End Sub Button1OnClick;

При нажатии на кнопку будет вызвана справка по работе с окном регистрации.

Примечание. Более подробную информацию о создании карты идентификаторов (Map ID), ключевых слов (Keyword Link, ALink) и индексных ключевых слов (Index Keyword, KLink) можно узнать в руководстве по конкретному программному продукту для создания справочной системы.