IWinApplicationHelp.ALinkLookup

Fore Syntax

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

Fore.NET Syntax

ALinkLookup(Keyword: String; HelpFile: String);

Parameters

Keyword - keyword, based on which the search is executed. Keywords are determined on help design stage; these words are not shown on the index page and used for internal search and help pages comparison.

HelpFile - optional parameter determining the help file name where the keyword is to be searched. If the parameter is not set, the search is executed 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.

Description

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

Add a link to the UI system assembly.

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.

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

After executing the example, after the button is clicked, the search is executed by the keywords mapped with 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.ALinkLookup("Directory", "C:\Help\Project.chm");
End Sub;