dlgEvent_Before_EditDialog

Function called before user edits a dialog at the form level.

Syntax

PUBLIC FUNCTION dlgEvent_Before_EditDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type,
   nextField STRING )
  RETURNS (libdbappEvents.DlgCtrlInstruction_Type, STRING)

The function parameters are:

dlg. This is a ui.DIALOG object referencing the current dialog. The dialog can implement an INPUT, INPUT ARRAY, DISPLAY ARRAY, MENU, or CONSTRUCT. 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

Exit menu EXIT_MENU 4
nextfield is a string containing the name of the form field that the focus will go to next.

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

Returns:

A dialog instruction value defined by the libdbappEvents.DlgCtrlInstruction_Type type.
The string type returns the name of the field that the focus will go to on return.

Usage

When you select the Before Edit Dialog property for the creation of the event, a function shell is created. Enter your code in the function.

This function is called at startup of a dialog for input (INPUT ARRAY) before the program gives control to the user. You can code to display messages to the user, initialize program variables, and set up the dialog instance by deactivating actions the user is allowed or not allowed to execute.

Example: form Before Edit Dialog

This example uses the Before Edit Dialog code event for the Account form in the OfficeStore demo.

The function changes the text on a form label.

PUBLIC FUNCTION dlgEvent_Before_EditDialog(dlg ui.DIALOG, uiMode SMALLINT, 
                dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type, 
                nextField STRING)
    RETURNS (libdbappEvents.DlgCtrlInstruction_Type, STRING)
    
    DEFINE f ui.Form
    
    DISPLAY "dlgEvent_Before_EditDialog (Form scope) is raised"
    LET f = dlg.getForm()
    CALL f.setElementText("Label10","Postal Code")
    DISPLAY "dlgEvent_Before_EditDialog (Form scope) is exited" 

    RETURN dlgCtrlInstruction, nextField
END FUNCTION