Icon: _getText

Icon: _getText

Returns the character return value of an icon

Inherited from Widget

Syntax
Details
Example

Syntax

CALL NOTIFY (icon-name, '_getText', text-value);

Argument Type Description

text-value
C returns the character return value associated with the icon. This value is blank if you did not select the icon.

Argument	Type	Description
text-value	C	returns the character return value associated with the icon. This value is blank if you did not select the icon.

Details

If you assigned an icon a numeric return value in the Value on Selection window, this method causes a program halt. Use the _getValue method to return the value of an icon that has a numeric return value.

Example

If the value print was assigned to the icon in the Value on Selection window, _getText returns the value print and assigns it to the variable TEXT:

   length text $ 24;
   call notify('icon1','_get_text_',text);
   if (text='print') then
      _msg_='You have selected the print 
             option.';

You can also use simple SCL assignment statements or PUT statements to access the value of icon objects. For example, if print is the return value for ICON1 and the icon is selected, the following statements will print icon1=print and assign the value print to the SCL variable A:

   put icon1=;
   A = icon1;

However, remember that SCL statements and functions do not work across FRAME entry boundaries. To access the value of an icon from another FRAME entry, use the _getText method instead.

Chapter Contents
Previous
Next
Top of Page