OBJECT Get value
OBJECT Get value ( objectName ) : any
| Parameter | Type | Description | |
|---|---|---|---|
| objectName | Text | → | Object name |
| Function result | any | ← | Current value of the form object's data source |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The OBJECT Get value command returns the current value of the data source for the form object(s) designated by the objectName parameter.
In the objectName parameter, pass the name of a form object (string). If you use the wildcard character (“@”) for multiple objects, only the value of the data source from the first form object is returned.
Note: OBJECT Get value is not available on list box column objects.
Returned value
Current value of the form object's data source.
Notes:
- If the data source is an array, the command returns the index of the array
- If the data source is an expression, the command returns the value evaluated value since the last execution cycle
Example
See the example for the OBJECT SET VALUE command.