#ELEMENT:CHOICE
Used to create ITEMS of type RADIO BUTTON or CHECK BOX, which contain a list of options that the user can select
| TITLE | DATA_CODE | QUESTION TYPE | COMMENTS | |
|---|---|---|---|---|
| Title of Question | TITLE | TEXT AREA | This is the text to be shown when the FORM is not being edited | |
| Title of Question on edit | TITLE_ON_EDIT | TEXT AREA | This is the text to be shown when the FORM is being edited (the user is answering the question) | |
| Question type | ID_TIPO_PREGUNTA | VERTICAL_RADIO | ||
| Required? | OBLIGATORIO_SN | BOOLEAN | ||
| Monitoring Report? | INFORME_SEGUIMIENTO_SN | BOOLEAN | ||
| Formula | FORMULA | TEXT | ||
| Default value | VALOR_POR_DEFECTO | TEXT | ||
| Tabulation | TABULACION | NUMERICAL | ||
| Condition | CONDICION | TEXT | ||
| Visibility condition | VISIBILITY_CONDITION | TEXT | Condition to determine whether this ITEM can be viewed by the active USER or not. In run-time, if this condition evaluates to 'false' then the ITEM will not be returned by API functions like form_get_summary() (but it is still considered to exist in the FORM) | |
| Number of associated questions | NUM_ASOCIADAS | NUMERICAL | ||
| Datacode | DATA_CODE | TEXT | ||
| Hidden | HIDDEN | VERTICAL_RADIO | ||
| Automatic options | OPTIONS | TEXT | ||
Title format | LITERAL_FORMAT | JSON | Format attributes for the TITLE. For information about the contents of the JSON see FORM TEMPLATE OBJECT#LITERAL_FORMAT | |
| Answer format | VALUE_FORMAT | JSON | Format attributes for the value. For information about the contents of the JSON see FORM TEMPLATE OBJECT#LITERAL_FORMAT | |
| Arrangement | ARRANGEMENT | JSON | Attributes to define the arrangement of the question & answer in the screen. For information about the contents of the JSON see FORM TEMPLATE OBJECT#ARRANGEMENT_FORMAT | |
| Images | ||||
| ARRAY OF 2 QUESTION | Image | ITEM_IMAGE | JSON | Contains a reference to a LIBRARY RESOURCE OBJECT. This is normally used to associate a picture to an ITEM of type RADIO BUTTON or CHECK BOX so that the selection of the options can be done clicking on an image instead of selecting from a list of textual options. This field must be used in combination with the property OPTION_REGION, which contains the definition of the region of the image that corresponds to the selected option (see below the properties of OPTIONS) To get further information about the format of the JSON string see LIBRARY RESOURCE INFO (JSON) |
| Formula | ITEM_IMAGE_FORMULA | TEXT | Allows to define a FORMULA that will be used to calculate the reference of the IMAGE associated to this ITEM. If the evaluation of the FORMULA returns NULL or an invalid image reference, then the default image uploaded in the property ITEM_IMAGE will be used. IMPORTANT: The FORMULA should return a reference to the image, no the image bytes. Example of valid FORMULA: ITEM{4}.ANSWER{IMAGE_REF]
Introduced in API Version 2.7.20 | |
| Order of image | ITEM_IMAGE_ORDER | NUMERICAL | ||
| Options | Array of available options | |||
| ARRAY OF 6 QUESTIONS | Reference of option | OPTION_REF | NUMERICAL | READ ONLY: This value is generated automatically. A unique reference value for each of the OPTIONs defined in the ITEM |
| Text of option | OPTION_TITLE | TEXT | ||
| Value of option | OPTION_VALUE | TEXT | ||
| Order of option | OPTION_ORDER | NUMERICAL | ||
| Image associated to option | OPTION_IMAGE | JSON | Contains a reference to a LIBRARY RESOURCE OBJECT. This is normally used to associate a picture to an option so that it can be graphically presented in the user interface instead of only displaying a text. To get further information about the format of the JSON string see LIBRARY RESOURCE INFO (JSON) | |
| Definition of a region in one of the IMAGES associated to the ITEM | OPTION_REGION | JSON | Permits to define a region of one of the images defined in ITEM_IMAGE property. The region is defined as a JSON string with the following structure: { "resource_ref" : 2123,
"region" : "12,35,14,55,90,33, ... ]
}
| |