IWinApplicationHelp.DisplaySearch

Синтаксис Fore

DisplaySearch([HelpFile: String = ""]);

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

DisplaySearch(HelpFile: String);

Параметры

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

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

Описание

Метод DisplaySearch открывает файл справки на вкладке «Поиск».

Пример Fore

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

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

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Var
    Help: IWinApplicationHelp;
Begin
    Help := WinApplication.Help;
    Help.FileName := "C:\Help\Project.chm";
    Help.DisplaySearch;
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.FileName := "C:\Help\Project.chm";
    Help.DisplaySearch("");
End Sub;

См. также:

IWinApplicationHelp