IWinApplicationHelp.Context

Синтаксис Fore

Context(TopicID: Integer; [HelpFile: String = ""]);

Синтаксис Fore.NET

Context(TopicID: Integer; HelpFile: String);

Параметры

TopicID - идентификатор страницы справки. Для использования идентификаторов на этапе проектирования справки должна быть сгенерирована карта идентификаторов.

HelpFile - необязательный параметр, определяющий наименование файла справки, в котором будет осуществляться поиск страницы с идентификатором TopicID. Если параметр не установлен, поиск осуществляется в файле, указанном в свойстве FileName.

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

Описание

Метод Context осуществляет поиск страницы, которой сопоставлен числовой идентификатор TopicID, в файле справки, и в случае удачного поиска открывает файл справки с позиционированием на данной странице.

Комментарии

Для работы данного метода необходимо, чтобы для файла справки на этапе проектирования была сгенерирована карта идентификаторов.

Более подробную информацию о карте идентификаторов можно найти в руководстве по конкретному программному продукту по справочной документации.

Пример Fore

Для выполнения примера предполагается наличие формы и расположенной на ней кнопки, а также наличие файла справки «C:\Help\Project.chm». Пример является обработчиком события OnClick для компонента «Button1».

Добавьте ссылку на системную сборку UI.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Var
    Help: IWinApplicationHelp;
Begin
    Help := WinApplication.Help;
    Help.Context(560148, "C:\Help\Project.chm");
End Sub Button1OnClick;

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

Пример Fore.NET

Необходимые требования и результат выполнения примера Fore.NET совпадают с примером Fore. Вместо компонентов Fore используйте их Fore.NET аналоги.

Imports Prognoz.Platform.Interop.Ui;
Private Sub button1_Click(sender: System.Object; e: System.EventArgs);
Var
    WinAppCls: WinApplicationClass = New WinApplicationClassClass();
    Help: IWinApplicationHelp;
Begin
    Help := WinAppCls.Help;
    Help.Context(560148, "C:\Help\Project.chm");
End Sub;

См. также:

IWinApplicationHelp