Please enable JavaScript to view this site.

ESL Documentation

Object/Item Inquiry Built-in Function

Return the current check state of a radio button, check box, or choice.

For Radio Buttons and Check Boxes:

(OBJECT_NAME is checked)

For Choices:

(item ITEM_NAME [from AB_NAME] in REGION_NAME is checked)

OBJECT_NAME

The identifier for a radio button or check box.

ITEM_NAME

The name of an item.

from AB_NAME

The identifier for an action bar template. You must specify the action bar name if more than one template contains an item of the given name. You cannot specify the action bar name if the item was defined outside of an action bar template. In ESL for Windows, only those regions that are children of the desktop can have action bars.

REGION_NAME

The identifier for a region containing the item.

Description

The value returned is the boolean associated with the check state of the specified object or item.

If the object or item is checked, the value true is returned; if it is unchecked, the value false is returned.

For items, the entire statement must be enclosed in parentheses.

Example

 

response to OK

if (Copy_To_All is checked) then

 check Copy_To_Disk

 check Copy_To_Network

end if

 

response to Make_Graph

 if (item Bar from View_Graph_Window_AB in

         View_Graph_Window is checked) then

         action GBars

 end if

See Also

check and uncheck Action Statements