of_clickLabel

Description

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

Syntax

of_clickLabel(Long label)
of_clickLabel(String label)

of_clickLabel(Long group, Long label)
of_clickLabel(String group, String label)

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.
label The text or index for the label to be clicked. The text of the label is the text the programmer gave when of_addLabel was called or when of_setText was last called. The index of the label is the same as the value returned when of_addLabel 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 label without user intervention.

In order to use this method, the group and label 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 labels using the same text and call the method using the text of the group or label item, the first one found of each in the XPListBar will be used in the "click".

Examples

of_clickLabel('Enable', 'Paste')

See Also

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