dlgEvent_Before_EmptyDialog

Function called when a form is opened without data (empty).

Syntax

PUBLIC FUNCTION dlgEvent_Before_EmptyDialog( 
   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 Table 2.
    Table 2. Dialog control instructions empty dialog
    Description Constant Value
    Continue menu CONTINUE_MENU 4
    Exit menu EXIT_DIALOG 5

The function returns a dialog control instruction value defined by libdbappEvents.DlgCtrlInstruction_Type.

Usage

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

If the form or relation Destination UI Settings Open mode property is set to Empty, the form opens in empty mode (without data). Use this function to enable/disable actions and display a message to the user:

Example: Before Empty Dialog

This example uses the Before Empty Dialog code event for a form in the OfficeStore demo.

In this example, the function disables an action. 

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

    CALL libdbappCore.log(C_LOG_INFO, "dlgEvent_Before_EmptyDialog (Form scope) is raised)
    CALL dlg.setActionActive("print_list", FALSE)
    MESSAGE "You are now in an empty form"
    CALL libdbappCore.log(C_LOG_INFO, "dlgEvent_Before_EmptyDialog (Form scope) is exited")

    RETURN dlgCtrlInstruction
END FUNCTION

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