About Methods

Methods enable you to access functionality within the HTML Help ActiveX control through the use of a scripting language, such as JavaScript or Visual Basic Scripting Edition. Generally, methods use the information specified in the <PARAM> tags of the specified HTML Help ActiveX control to determine what functionality is actually to be invoked.

The following example uses the Click method to invoke a command:


<A HREF=JavaScript:<i>related</i>.Click()<Example>/A> 

where JavaScript is the scripting language, related is the ID of the HTML Help ActiveX control being referenced, Click() is the method, and Example is the text link. The Click() method requires that the control contain <PARAM> tags that specify which command to invoke.

Some methods do not require any parameters to access functionality within the HTML Help ActiveX control. In these cases, if <PARAM> tags are present in a referenced control, they are ignored by the method being called. This lets you reuse an existing instance of the control in your HTML file.

In addition, you can call multiple methods from a single instance of the HTML Help ActiveX control. For example, if you are already using an instance of the control to call the Related Topics command, you can reference the ID of that same control to call the TextPopup method.

If you need to insert a new instance of the control to call a method that does not require parameters, you can omit the <PARAM> tags from the <OBJECT> tag as shown in the following example:


<OBJECT
id=<i>for_script</i>
type="application/x-oleobject"
classid="clsid:52a2aaae-085d-4187-97ea-8c30db990436"
>
</OBJECT>

where for_script is the ID of the HTML Help ActiveX control that you will reference to call a method. Methods that do not require <PARAM> tags are listed in the table, below.

Methods quick reference

Method Use with a compiled help file Use with uncompiled HTML files Does not require <PARAM> tags
Click X X
HHClick X X
Print X X
SyncURL X
TCard X
TextPopup X X X

 

Related topics

About the HTML Help ActiveX Control

 

 

Show: