dlgEvent_record_OnActionInsert

Function called to overwrite a predefined action to insert a row.

Syntax

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

This function is called to overwrite a predefined action to insert a new row before current row in a dialog controlling an INPUT ARRAY.
Note: Predefined actions are enabled and disabled automatically by the dialog depending on the context. For example, when a static array used by the INPUT ARRAY is full, the insert and append actions get disabled. Even when overwritten, the program will continue to enable and disable the actions automatically.

Example: On Action Insert

This example uses the On Action Append code event for the Order form in the OfficeStore demo.

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

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

    DISPLAY "dlgEvent_OrderItem_OnActionInsert (Row scope) is raised"
    DISPLAY "Current row index: ", dlg.getCurrentRow("OrderItem")
    DISPLAY  "No. of rows: ", dlg.getArrayLength("OrderItem")
    DISPLAY "dlgEvent_OrderItem_OnActionInsert (Row scope) is exited"

    RETURN dlgCtrlInstruction
END FUNCTION