IWinApplicationHelp.KeywordLookup

Fore Syntax

KeywordLookup(Keyword: String; [HelpFile: String = ""]);

Fore.NET Syntax

KeywordLookup(Keyword: String; HelpFile: String);

Parameters

Keyword - keyword, based on which help index is created.

HelpFile - optional parameter determining the help file name where the keyword is to be searched. If the parameter is not set, the search is performed in the file specified in the FileName property.

NOTE. If the path to help file is not specified, the file is searched in the folder, from which the current platform instance is started.

The KeywordLookup method searches for the Keyword keyword in help file and opens the help on the page matching the keyword.

Fore Example

Executing the example requires a form, a button on it and the C:\Help\Project.chm help file. The example is a handler of the OnClick event for the Button1 component.

Add a link to the UI system assembly.

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

After executing the example, after the button is clicked, the search is executed by the keywords that are added to the index and mapped with help pages.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example. Use Fore.NET analogs instead of Fore components.

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.KeywordLookup("Directory", "C:\Help\Project.chm");
End Sub;