ui.Dialog methods

ui.Dialog methods provide additional control to the following user interaction statements, used within a DIALOG ... END DIALOG block:

• CONSTRUCT
• DISPLAY ARRAY
• INPUT
• INPUT ARRAY

ui.Dialog methods are used during INPUT, INPUT ARRAY, and DISPLAY ARRAY dialogs (e.g., enable or disable actions and form fields dynamically during the dialog execution).

They cannot be used outside user interaction statements.

Available methods

General ui.Dialog methods

ui.Dialog.accept() ui.Dialog.getArrayLength() ui.Dialog.getCurrent() ui.Dialog.getCurrentItem()

ui.Dialog.getCurrentRow() ui.Dialog.setActionActive() ui.Dialog.setActionHidden() ui.Dialog.setCurrentRow()

Field manipulation methods

ui.Dialog.appendNode() ui.Dialog.appendRow() ui.Dialog.deleteAllRows() ui.Dialog.deleteNode() ui.Dialog.deleteRow() ui.Dialog.getFieldBuffer() ui.Dialog.getFieldTouched() ui.Dialog.insertNode() ui.Dialog.insertRow() ui.Dialog.isRowSelected()

ui.Dialog.nextField() ui.Dialog.selectionToString() ui.Dialog.setArrayAttributes() ui.Dialog.setCellAttributes() ui.Dialog.setDefaultUnbuffered() ui.Dialog.setFieldActive() ui.Dialog.setFieldTouched() ui.Dialog.setSelectionMode() ui.Dialog.setSelectionRange() ui.Dialog.validate()

ui.Dialog methods are applied to variables of the corresponding - ui.Dialog - type.

ui.Dialog objects can be used and manipulated in two ways:

• within a user interaction statement, or
• within a user-defined function.

In the first case  - within a user interaction statement - ui.Dialog method is predefined by the keyword, DIALOG, and doesn't need additional initialization or binding:

In the second case - within a user-defined function - you must use a variable:

Wrong call:

 

After the end of interaction statement, the ui.Dialog object is destroyed and its references become invalid. That is why a DIALOG keyword used outside an interaction statement will cause a compile-time error.

However, you can create a user-defined function that will serve as a dialog manipulation code and will be used for several interaction operations. In this case – within a user-defined function – you can create a ui.Dialog object beyond the user interaction block and declare its instance with the DEFINE statement:

Thus, you can use either a predefined ui.Dialog object within an interactive statement, or define a custom ui.Dialog object.