of_setVisible

Description

Sets the visible/invisible state of a group, label or link.

Syntax

of_setVisible(Long item, Boolean switch)
of_setVisible(String item, Boolean switch)

of_setVisible(String group, String item, Boolean switch)

Parameter(s)

Name Type Description
group String The name of the group containing the item for which the visible indicator is to be set. The text of the group is the text the programmer gave when of_addGroup was called or when of_setText was last called for the item. This parameter is optional.
item Long or String The name or index of the item for which the visible indicator is to be set. The text of the item is the text the programmer gave when of_addGroup, of_addLabel or of_addLink was called or when of_setText was last called for the item. The index of the item is the same as the value returned when of_addGroup, of_addLabel or of_addLink was called.
switch Boolean Indicates the state to which the item is to be set, TRUE = Visible and FALSE = Invisible.

Return Value

Returns SUCCESS (1) if successful and FAILURE (-1) if en error occurs.

Usage

When the group parameter is included, the item parameter should only contain a label or link reference. When the group parameter is excluded, the item parameter can reference a group, label or link.

Examples

// Turn File/Save invisible
of_setVisible('File', 'Save', FALSE)

// Turn File/Save visible
of_setVisible('Save', TRUE)

// Turn the group File invisible
of_setVisible('File', FALSE)

See Also

Last edited Sep 24, 2016 at 5:04 PM by cjharris02892, version 9