Help.ShowTopic Method

Applies to TestComplete 15.61, last modified on February 20, 2024

Description

Use the Help.ShowTopic method to display a specific help topic in the HTML Help viewer.

Declaration

Help.ShowTopic(Topic)

Topic [in]    Required    String    
Result None

Applies To

The method is applied to the following object:

Parameters

The method has the following parameter:

Topic

Specifies the name of the help file (.chm), followed by the path to the desired topic within this help file, and, optionally, the name of the window type to be used, in the following format:

HelpFile.chm::/Topic.htm>MainWin

If you omit the window type name, the topic will be opened in the default help window.

Result Value

None.

Remarks

The Help object along with all of its methods can only be used in the source code of the script extensions. This object does not exist in TestComplete scripts.

Example

The following code snippet demonstrates the Help.ShowTopic method usage:

JScript

// script.js

Help.ShowTopic("MyHelpFile.chm::/Start.htm");

VBScript

' script.vb

Help.ShowTopic "MyHelpFile.chm::/Start.htm"

See Also

ShowContext Method
ShowURL Method

Highlight search results