dlgEvent_record_BeforeInput
Function called by a dialog code event before input at the record level.
Syntax
PUBLIC FUNCTION dlgEvent_record_BeforeInput(
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 theDIALOG
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 Exit menu EXIT_MENU
4
libdbappEvents.DlgCtrlInstruction_Type
type.Usage
When you select the Before Input property for the creation of the event, a function shell is created. Enter your code in the function.
This function is called at set up of the INPUT
or INPUT ARRAY
dialog instance before the program gives control to the user. Use this function to display messages
to the user, initialize program variables, or enable or disable actions.
Example: Before Input
This example uses the Before Input code event for the Account form in the OfficeStore demo.
In this example the reportprint
action is disabled.
PUBLIC FUNCTION dlgEvent_recAccount_BeforeInput(dlg ui.DIALOG, uiMode SMALLINT,
dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
DISPLAY "dlgEvent_recAccount_BeforeInput (Record scope) is raised"
CALL dlg.setActionActive("reportprint",FALSE)
DISPLAY "dlgEvent_recAccount_BeforeInput (Record scope) is exited"
RETURN dlgCtrlInstruction
END FUNCTION