of_setText

Description

Sets or changes the text displayed for a group, label or link.

Syntax

of_setText(Long item, String newText)
of_setText(String item, String newText)

of_setText(String group, String item, String newText)

Parameter(s)

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

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.

The text of an item is what is used in ue_itemClicking and ue_itemClicked. So if the text is changed, these events will have to handle the new text value.

Examples

of_setText('File', 'Open', 'Open File')

See Also

Last edited Oct 17, 2016 at 11:42 AM by cjharris02892, version 6