File_Field_Option - DataDictionary

Gets/sets the state of a field option for a table column

Type: Property

Access: Write-Only

Data Type: Boolean

Parameters: Integer iFile Integer iField Integer iOption

Parameter Description
iFile Number of table in current filelist
iField Number of the Column in the table
iOption The option to get/set

Parameter	Description
iFile	Number of table in current filelist
iField	Number of the Column in the table
iOption	The option to get/set

Syntax

 Property Boolean File_Field_Option

Write Access: Set File_Field_Option iFile iField iOption to BooleanVariable/Value

Description

The File_Field_Option property is used to set a DD field option for a specified table and column. This message was created so that DD option changes could be dynamic. Changes made to DD options will be immediately reflected by data-entry objects using this field.

Set File_Field_Option of hDD iFile iField DD_Retain to True
Set File_Field_Option of hDD File_Field FileName.FieldName DD_Retain to False

If you need to set or change field options anywhere else within an application you should use the message File_Field_Option.

The options that can be set in DataFlex are:

DD_AutoFind
DD_AutoFind_GE
DD_CapsLock
DD_DisplayOnly
DD_FindReq
DD_ForcePut
DD_NoEnter
DD_NoPut
DD_Required
DD_Retain
DD_Retain_All
DD_SkipFound
DD_Zero_Suppress

See Field_Option for a description of these options.

Currently a DD_Capslock is not immediately reflected in all objects - the object has to be deactivated and reactivated for the Capslock to take effect.

Note that you can use the message Field_Option instead of File_Field_Option if you are sure the message is being sent directly to the DD that owns the field. Often you will find that within a DDO you need to set options for parent or child DDOs. In this case you must use the File_Field version of this message. Field_Option is used by the Visual DataDictionary Modeler when setting options within the DD's constructor. When used outside of Construct_Object, our advice is that you always use the file_field version of DD messages as this makes it simpler for you.

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 Field and File_Field DD Interfaces.

The Field_ version of a message must use the keyword FIELD to identify the file.field name. The File_Field_ version must use the keyword FILE_FIELD to identify the file.field values. These should never be mixed!

// When using Field_ message use the FIELD keyword
Set Field_Option Field Customer.Customer_Name DD_SkipFound to True

// When using the File_Field_ message use the FILE_FIELD keyword
Set File_Field_Option of oCustomer_DD File_Field Customer.Name DD_SkipFound to True

Alternate (obsolete) Set Syntax

Prior to version 14.1, the Set File_Field_Option had a different syntax, which only supported the setting (enabling) of an option. File_Field_Option_Clear was used to clear an option. The alternate syntax is now obsolete, but it is still supported for compatibility reasons. The alternate syntax has two parameters, the Column number and the Field Option to be set.

Set File_Field_Option of hDD iField to DD_NoPut
Set File_Field_Option of hDD Field FileName.FieldName to DD_NoPut

In addition, multiple options could be set by IOR-ing their values

Set File_Field_Option of hDD iField to (DD_Retain IOR DD_NoEnter)

This syntax is now obsolete and is discouraged.