of_getText

Description

Retrieves the text for a group, label or link.

Syntax

of_getText(Long item)
of_getText(String item)

of_getText(String group, String item)

Parameter(s)

Name Type Description
group Long or String The name of the group containing the item for which the text is to be retrieved. 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 retrieved. 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.

Return Value

Returns a string containing the name of the item. If the item does not exist, an EMPTY string is returned.

Usage

When calling of_getText with a string, it basically verifies that the item name requested exists in the list of items and is essentially the same as calling of_locateItem.

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

String              ls_text
ls_text             = of_getText(1)


IF of_getText('Open') = 'Open' THEN
.
.
.
END IF

See Also

Last edited Oct 17, 2016 at 11:52 AM by cjharris02892, version 8