DISPLAY ARRAY instruction configuration

HELP option

The HELP clause specifies the number of a help message to display if the user invokes the help in the DISPLAY ARRAY dialog. The predefined 'help' action is automatically created by the runtime system. You can bind action views to the 'help' action.

The HELP clause overrides the HELP attribute.

COUNT option

When using a dynamic array, the number of rows to be displayed is defined by the number of elements in the dynamic array; the COUNT attribute is ignored.

When using a static array or the paged mode, the number of rows to be displayed is defined by the COUNT attribute. You can also use the SET_COUNT() built-in function, but it is supported for backward compatibility only. If you don't know the total number of rows for the paged mode, you can specify -1 for the COUNT attribute (or in the SET_COUNT() call before the dialog block). With COUNT=-1, the dialog will ask for rows by executing ON FILL BUFFER until less rows are provided than are required, or if you reset the number of rows to a value higher than -1 with ui.Dialog.setArrayLength().

KEEP CURRENT ROW option

Depending on the list container used in the form, the current row may be highlighted during the execution of the dialog, and cleared when the instruction ends. You can change this default behavior by using the KEEP CURRENT ROW attribute, to force the runtime system to keep the current row highlighted.

ACCEPT option

The ACCEPT attribute can be set to FALSE to avoid the automatic creation of the default accept action. Use this attribute when you want to avoid dialog validation, or if you need to write a specific validation procedure using ACCEPT DISPLAY.

CANCEL option

The CANCEL attribute can be set to FALSE to avoid the automatic creation of the cancel default action. Use this attribute when you only need a validation action (accept), or when you want to write a specific cancellation procedure using EXIT DISPLAY.

If the CANCEL=FALSE option is set, no close action will be created, and you must write an ON ACTION close control block to create an explicit action.

DOUBLECLICK option

The DOUBLECLICK option can be used to define the action that will be fired when the user chooses a row from the list. Different configuration options are available to control the row selection action of desktop and mobile devices. For more details, see Defining the action for a row choice.

DETAILACTION option

The DETAILACTION attribute can be used to define the action that will be fired when the user selects the detail button of a row. The detail button is typically shown with an (i) icon on iOS devices. Note that the DOUBLECLICK attribute can be used to distinguish the action when the user selects the row instead of the detail button in the row. For more details, see Row configuration on iOS devices.

FOCUSONFIELD option

When the FOCUSONFIELD option is used, the DISPLAY ARRAY allows focus at the field (or cell) level. It it then possible to implement BEFORE FIELD and AFTER FIELD blocks, as well as using NEXT FIELD instructions. However, the dialog still manages a read-only list. For more details, see Field-level focus in DISPLAY ARRAY.

ACCESSORYTYPE option

The ACCESSORYTYPE attribute can be used to define the decoration of rows, typically used on an iOS device. Values can be DETAILBUTTON, DISCLOSUREINDICATOR, CHECKMARK to respectively get an (i), > or check mark icon. For more details, see Row configuration on iOS devices.

Using TTY attributes

The ATTRIBUTES clause can define TTY attributes such as colors (RED, GREEN), and REVERSE. These attributes will be used during the dialog execution.