dlgEvent_record_AfterDisplay

Function called by dialog code events after display at the record level.

Syntax

PUBLIC FUNCTION dlgEvent_record_AfterDisplay( 
   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
    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.

Usage

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

This function is called at a DISPLAY ARRAY dialog when the user changes mode from display mode to input mode by selecting the "New", "Modify", or "Search" menu actions. Use this function to display messages to the user, initialize program variables, and set up the dialog instance for input; for example by deactivating actions the user is not allowed to execute.

Example: After Display

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

In this example the current row index and the number of rows in the array are displayed. 

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

    DISPLAY "dlgEvent_recAccount_AfterDisplay (Record scope) is raised"
    DISPLAY "row index is: ", arr_curr() 
    IF arr_curr() <= dlg.getArrayLength("recAccount") THEN
      DISPLAY "array length is: ",dlg.getArrayLength("recAccount")
    END IF
    DISPLAY "dlgEvent_recAccount_AfterDisplay (Record scope) is exited"
    
    RETURN dlgCtrlInstruction
END FUNCTION