dlgEvent_After_EditDialog

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

Syntax

PUBLIC FUNCTION dlgEvent_After_EditDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
  RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
The function parameters are:
  1. 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.
  2. 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
  3. 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
    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 After Edit Dialog property for the creation of the event, a function shell is created. Enter your code in the function.

This function is called before the dialog instruction for input (INPUT ARRAY) terminates. Dialog finalization code can be implemented in this block. For example, you can code to check whether a field value is correct and give control back to the dialog if the value is wrong.

Example: After Edit Dialog

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

The function checks the "email" field's value. If it is NULL, an error message is raised and the focus is returned to the field.

PUBLIC FUNCTION dlgEvent_After_EditDialog(dlg ui.DIALOG, uiMode SMALLINT,
      dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
    RETURNS (libdbappEvents.DlgCtrlInstruction_Type)

    DISPLAY "dlgEvent_After_EditDialog (Form scope) is raised"
    # This sample code may be written instead in a function that
                    you call. 
    # The function would be in a module shared by forms and
                    applications, and imported using the IMPORT FGL statement.
    IF dlg.getfieldValue("account.email") IS NULL THEN
        ERROR " Email address is needed "
        CALL dlg.nextField("account.email")
        LET dlgCtrlInstruction = libdbappEvents.CONTINUE_DIALOG
    END IF
    DISPLAY "dlgEvent_After_EditDialog (Form scope) is exited"

    RETURN dlgCtrlInstruction
END FUNCTION