dlgEvent_record_AfterInput

Function called by dialog code event after input at the record level.

Syntax

PUBLIC FUNCTION dlgEvent_record_AfterInput( 
   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 Input property for the creation of the event, a function shell is created. Enter your code in the function.

Use this function to implement validation rules (for example, values the user needs to input to satisfy constraints) for several fields in the INPUT (fields in a GRID container) dialog instance.
Note:

For an INPUT ARRAY (fields in a row in a table container) dialog instance, use the AfterRow function.

This function is called before the default validation that the BAM generates for an INSERT, UPDATE, DELETE. This means it is called before:
  • prompting the user for confirmation with a (Yes/No/Cancel) dialog
  • processing the CRUD operation or in the case of failure displaying the SQL error and continuing the dialog

Example: After Input

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

In this example the function checks the user input in the "account.city" and "account.zip" fields. It tests a condition where the zip field has a value but the city field is null. When the condition is true, an error message is raised and the focus is returned to the city field.

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

    CALL libdbappCore.log(C_LOG_INFO, SFMT("dlgEvent_recAccount_AfterInput (Row scope) is raised -  uimode = %1", uiMode))
    DISPLAY "  recAccount.city = ", dlg.getFieldBuffer("account.city")
    DISPLAY "  recAccount.zip = ", dlg.getFieldBuffer("account.zip")
    IF dlg.getFieldBuffer("account.city") IS NULL AND dlg.getFieldBuffer("account.zip") IS NOT NULL THEN
        DISPLAY " IN AFTER INPUT You must specify a city because zipcode is not null."
        ERROR " You must specify a city because zipcode is not null."
        CALL dlg.nextField("account.city")
        LET dlgCtrlInstruction = libdbappEvents.CONTINUE_DIALOG
    END IF
    CALL libdbappCore.log(C_LOG_INFO, "dlgEvent_recAccount_AfterInput (Record scope) is exited")

    RETURN dlgCtrlInstruction
END FUNCTION

For more information on the libdbappCore.log() function, go to DBAPPDEBUG and the debug level API.