of_getText

Description

Retrieves the name of an item.

Syntax

of_getText(Long item)
of_getText(String item)

Parameter(s)

Name Type Description
item Long or String The name or index of button for which the name is to be retrieved. The name of the button is the name the programmer gave when of_addItem or of_setText was called. The name is the text displayed for a toolbar when display text is enabled. The index of the button is the same as the value returned when of_addItem 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.

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:26 AM by cjharris02892, version 12