of_clickLink

Description

Causes a link to be clicked programmatically, without user intervention.

Syntax

of_clickLink(Long link)
of_clickLink(String link)

of_clickLink(Long group, Long link)
of_clickLink(String group, String link)

Parameter(s)

Name Description
group The text or index for the group to be clicked. The text of the group is the text the programmer gave when of_addGroup was called or when of_setText was last called. The index of the group is the same as the value returned when of_addGroup was called. This parameter is optional and has no default value.
link The text or index for the link to be clicked. The text of the link is the text the programmer gave when of_addLink was called or when of_setText was last called. The index of the link is the same as the value returned when of_addLink was called.

Return Value

Returns a long indicating the result of the call, ALLOW (1) if the call succeeded or PREVENT (-1) if there was an error.

Usage

Use this method when you want to execute the script associated with a link without user intervention.

In order to use this method, the group and link must both be enabled and visible. If it is not, an error message is displayed and PREVENT is returned.

If you have multiple groups or links using the same text and call the method using the text of the group or link item, the first one found of each in the XPListBar will be used in the "click".

Examples

of_clickLink('File', 'Print')

See Also

Last edited Sep 24, 2016 at 4:57 PM by cjharris02892, version 3