GET FIELD ENTRY PROPERTIES
GET FIELD ENTRY PROPERTIES ( fieldPtr|tableNum {; fieldNum}; list ; mandatory ; nonEnterable ; nonModifiable )
| Parameter | Type | Description | |
|---|---|---|---|
| fieldPtr|tableNum | Pointer, Longint | → | Field pointer or table number |
| fieldNum | Integer | → | Field number if the table number is passed as first parameter |
| list | Text | ← | Associated choice list name or empty string |
| mandatory | Boolean | ← | True = Mandatory, False = Optional |
| nonEnterable | Boolean | ← | True = Non-enterable, False = Enterable |
| nonModifiable | Boolean | ← | True = Non-modifiable, False = Modifiable |
Description
The GET FIELD ENTRY PROPERTIES command returns the data entry properties for the field specified by tableNum and fieldNum or by fieldPtr.
You can either pass:
- table and field numbers in tableNum and fieldNum, or
- a pointer to the field in fieldPtr.
Note: This command returns the properties defined at the structure window level. Similar properties can be defined at the form level.
Once the command has been executed:
- The list parameter returns the choice list name associated to the field (if any). A list can be associated to the following field types: String, Text, Real, Integer, Long Integer, Date, Time and Boolean.
If there is no choice list associated to the field or if the field type is not suitable for a choice list, an empty string is returned (""). - The mandatory parameter returns True if the field is “Mandatory”; else False. The Mandatory attribute can be set for all field types, except for BLOB.
- The nonEnterable parameter returns True if the field is “Non-enterable”, else False. A non-enterable field can only be read, no data can be entered. The non-enterable attribute can be set for all field types, except for BLOB.
- The nonModifiable parameter returns True if the field is “Non-modifiable”, else False. A non-modifiable field can be entered just once and cannot be modified anymore. The Non-modifiable attribute can be set for all field types, except for BLOB.
See also
GET FIELD PROPERTIES
GET RELATION PROPERTIES
GET TABLE PROPERTIES
Properties
| Command number | 685 |
| Thread safe | ✗ |