IWinApplicationHelp.DisplayIndex

Fore Syntax

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

Fore.NET Syntax

DisplayIndex(HelpFile: String);

Parameters

HelpFile.Optional parameter determining the name of help file to be opened. If the parameter is not set, the system opens 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 DisplayIndex method opens the help file on the Index tab.

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.FileName := "C:\Help\Project.chm";
    Help.DisplayIndex;
End Sub Button1OnClick;

Clicking the button opens the specified help file on the Index tab.

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.FileName := "C:\Help\Project.chm";
    Help.DisplayIndex("");
End Sub;