of_clickGroup

Description

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

Syntax

of_clickGroup(Long group)
of_clickGroup(String group)

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

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 group without user intervention.

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

If you have multiple groups using the same text and call the method using the text of the group item, the first one found in the XPListBar will be "clicked".

Examples

of_clickGroup('Enable')

See Also

Last edited Sep 24, 2016 at 4:55 PM by cjharris02892, version 5