"@FORM" OBJECT CODE (FORM TEMPLATE)
- Pedro Jose Sanchez Luling
Introduced in API Version 2.7.22
Object code format
@FORM{selector}.property
parent_object.@FORM{selector}.property
parent_object.FORM{selector}.property
Note that the initial @ symbol is only necessary if no parent object has been specified in the OBJECT CODE expression (e.g. @FORM{xx}.REF), because otherwise the it could be mistaken with the "FORM" OBJECT CODE.
Nevertheless the @ symbol can be omitted if a parent object is specified, because the context allows to know that we refer to a FORM TEMPLATE and not to a FORM.
| Possible parent objects | Example |
|---|---|
<none> | @FORM.REF |
| @TASK | @TASK{task_code}.@FORM{form_code}.REF @TASK{task_code}.FORM{form_code}.REF |
Returns information about a FORM TEMPLATE
Context information
| Required context objects |
|---|
| TASK TEMPLATE or PROGRAM |
When this OBJECT CODE is used independently (no parent), all FORM TEMPLATEs in the current PROGRAM (the one where the OBJECT CODE is evaluated) are considered
Otherwise the FORM TEMPLATE is searched in the scope defined by the parent OBJECT.
It is mandatory to provide the desired FORM CODE as the selector of the OBJECT CODE
Properties
| PROPERTY | DESCRIPTION |
|---|---|
@FORM{form_code} | FORM object. The selector is mandatory and must be a valid FORM CODE that corresponds to a FORM TEMPLATE of the PROGRAM |
| @FORM{form_code}.REF | FORM TEMPLATE OBJECT reference |
| @FORM{form_code}.NAME.* | An object of type DESCRIPTION that contains the name of the FORM TEMPLATE OBJECT |
@FORM{form_code}.@ITEM{item_id | item_code}.* @FORM{form_code}.ITEM{item_id | item_code}.* | ITEM TEMPLATE OBJECT include in the FORM TEMPLATE OBJECT. See "@ITEM" OBJECT CODE (ITEM TEMPLATE) |