dlgEvent_record_OnFieldsActivation

Function called to activate fields at the record level.

Syntax

PUBLIC FUNCTION dlgEvent_record_OnFieldsActivation( 
   dlg ui.DIALOG, 
   uiMode SMALLINT )

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

Usage

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

Use this event to enable / disable record fields or set an action that is active only for specific fields when they have the focus. For example, an action to open a zoom form might only apply to a specific field, such as a country field in an address.

Example: On Fields Activation

This example uses the On Fields Activation code event for the Account form in the OfficeStore demo.

In this example the account.sourceapp field is disabled when the uiMode is set to add or modify. 


PUBLIC FUNCTION dlgEvent_recAccount_OnFieldsActivation(dlg ui.DIALOG, uiMode SMALLINT)
    
    DISPLAY "dlgEvent_recAccount_OnFieldsActivation (Record scope) is raised"
    IF (uiMode = C_MODE_ADD OR C_MODE_MODIFY) THEN
       CALL dlg.setFieldActive("account.sourceapp", FALSE)
    END IF
    DISPLAY "dlgEvent_recAccount_OnFieldsActivation (Record scope) is exited"
END FUNCTION