of_setTipText

Description

Sets or changes the toolTip text of a group, label or link.

Syntax

of_setTipText(Long item, String toolTip)
of_setTipText(String item, String toolTip)

of_setTipText(String group, String item, String toolTip)

Parameter(s)

Name Type Description
group String The name of the group containing the item for which the toolTip 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 toolTip 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.
toolTip String A string containing the text to be displayed as the item's toolTip.

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

// ToolTip for 'Save' label
of_setTipText('File', 'Save', 'Save the contents of the current window')

// ToolTip for 'File' group
of_setTipText('File', 'Lists commands dealing with file contents'

See Also

Last edited Sep 24, 2016 at 5:03 PM by cjharris02892, version 7