OBJECT Get action
OBJECT Get action ( {* ;} object ) -> Function result
| Parameter | Type | Description | |
|---|---|---|---|
| * | Operator | → | If specified, object is an object name (string) If omitted, object is a field or variable |
| object | any | → | Object name (if * is specified) or Field or variable (if * is omitted) |
| Function result | Text | ← | Associated standard action name and (if any) parameter string |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The OBJECT Get action command returns the name and (if any) parameter of the standard action associated with the object(s) designated by the object and * parameters.
Passing the optional * parameter indicates that the object parameter is an object name (string). If you do not pass this parameter, it indicates that the object parameter is a field or variable. In this case, you pass a field or variable reference instead of a string (field or variable object only).
You can set a standard action for an object in the Form editor using the Property List, or using the OBJECT SET ACTION command. OBJECT Get action returns a string containing the name of the standard action associated with the object (as well as its parameter, if any).
For a comprehensive list of standard actions, please refer to the Standard actions section in the Design Reference manual.
Example
You want to associate the "Cancel" action with all the objects in the form that do not already have any associated action:
ARRAY TEXT($arrObjects;0)
FORM GET OBJECTS($arrObjects)
For($i;1;Size of array($arrObjects))
If(OBJECT Get action(*;$arrObjects{$i})=ak none)
OBJECT SET ACTION(*;$arrObjects{$i};ak cancel)
End if
End for