dlgEvent_record_BeforeDisplay
Function called by dialog code events before display at the record level.
Syntax
PUBLIC FUNCTION dlgEvent_record_BeforeDisplay(
dlg ui.DIALOG,
uiMode SMALLINT,
dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
The function parameters are:
dlg
. This is aui.DIALOG
object referencing the current dialog. The dialog can implement anINPUT
,INPUT ARRAY
,DISPLAY ARRAY
,MENU
, orCONSTRUCT
. For more information, see The Dialog class in Genero Business Development Language User Guide.uiMode
. This is an integer value defining the current mode or state in relation to user action in the dialog, form, or application. Modes are defined as constants in the libdbappFormUI file in the libdbapp library.Table 1. UI modes Description Applies to ... Constant Value Display DISPLAY ARRAY
C_MODE_DISPLAY 1 Modify INPUT \ INPUT ARRAY
C_MODE_MODIFY 2 Add INPUT \ INPUT ARRAY
C_MODE_ADD 3 Search CONSTRUCT
C_MODE_SEARCH 4 Empty MENU
C_MODE_EMPTY 5 Exit form The form C_MODE_EXIT_FORM 6 Exit app The app C_MODE_EXIT_APP 7 Undefined All (array, form, or app) C_MODE_UNDEFINED 0 dlgCtrlInstruction
is a libdbappEvents.DlgCtrlInstruction_Type defining the dialog control instruction. Instructions available in the function are shown in the table.Table 2. Dialog control instructions Description Constant Value Accept dialog ACCEPT_DIALOG
1 Continue dialog CONTINUE_DIALOG
2 Exit dialog EXIT_DIALOG
3
The function returns a dialog control instruction value defined by libdbappEvents.DlgCtrlInstruction_Type
.
Usage
When you select the Before Display property for the creation of the event, a function shell is created. Enter your code in the function.
Use this function at DISPLAY ARRAY
dialog setup, to display messages to the
user, initialize program variables, and set up the dialog instance; for example by deactivating
actions the user is not allowed to execute.
Example: Before Display
This example uses the Before Display code event for the Account form in the OfficeStore demo.
In this example the actions to delete and update are disabled when the array has records.
PUBLIC FUNCTION dlgEvent_recAccount_BeforeDisplay(dlg ui.DIALOG, uiMode SMALLINT,
dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
DISPLAY "dlgEvent_recAccount_BeforeDisplay (Row scope) is raised"
IF dlg.getArrayLength("recAccount")>0 THEN
CALL dlg.setActionActive("delete",FALSE)
CALL dlg.setActionActive("update",FALSE)
ELSE
CALL dlg.setActionActive("delete",TRUE)
CALL dlg.setActionActive("update",TRUE)
END IF
DISPLAY "dlgEvent_recAccount_BeforeDisplay (Record scope) is exited"
RETURN dlgCtrlInstruction
END FUNCTION