File_Field_CheckBox_Value - DataDictionary
Returns the symbolic value for a foreign table column for the specified checkbox state (checked or unchecked)
Type: Property
Access: Read-Only
Data Type: String
Parameters: None
Parameters
| Parameter | Type | Description |
|---|---|---|
| iFile | Integer | Number of the table in the current filelist |
| iField | Integer | Number of the column in the table |
| iState | Integer | Determines which state is being accessed for column iField |
Syntax
Property String File_Field_CheckBox_Value
| Access Type | Syntax |
|---|---|
| Read Access: | Get File_Field_CheckBox_Value to StringVariable |
Description
Field_CheckBox_Value returns the symbolic value for a table column for the passed in checkbox state (checked or unchecked). Symbolic values other than 1 or 0 (True or False) can be stored in a table for the checked and unchecked values of a checkbox.
Checkbox values cannot be assigned for foreign table columns, only retrieved. To set the checkbox values for a (non-foreign) table column, use Field_CheckBox_Values.
Sample
String sStatus
Get File_Field_Checkbox_Value File_Field Driver.CorrectiveLenses True to sStatus
File and File_Field Interfaces
Many of the DataDictionary methods contain a two variants of the same message: Field_Message and File_Field_Message. For a complete description of these messages please refer to The File Field and Field Keywords.
The Field_ version of a message must use the keyword FIELD to identify the Table.Column name. The File_Field_ version must use the keyword FILE_FIELD to identify the Table.Column name. These should never be mixed!
// When using Field_ message use the Field keyword
Get Field_CheckBox_Value Field Customer.Sex to sCheckBoxValue
// When using the File_Field_ message use the File_Field keyword
Get File_Field_CheckBox_Value of oCustomer_DD File_Field Customer.Sex to sCheckBoxValue
See Also