skip to main content
OpenEdge Development: ADM Reference
Field Objects and Their Methods and Properties : Field object properties
 
Field object properties
Field object properties provide information about field objects and its classes. This information can include whether an object is enabled, the contents of the object and so on. You can read property values and in many instances you can change property values. To read a value for a property, you use a get function, and to change a value for a property, you use a set function.
These functions conform to the following conventions:
*get — Uses the form getpropname and returns the current value of the property.
Note: This function accepts no arguments.
*set — Uses the form setpropname. The set function accepts a single argument—the new value for the property—and returns TRUE/FALSE depending on whether the value change succeeds.
For more information about getting and setting property values, see Chapter 1, “ADM2 SmartObject API Reference.”
This section lists and describes the Field object properties that you can use with the get and set functions. The description also identifies the properties for which you can read and write (change) a value and the properties for which you can only read the value.
BaseQueryString
Base query string used for dynamic Lookups and dynamic Combos. This is the original query assigned to the object when initialized.
Data type: CHARACTER
Note: Read and Write.
BrowseFields
Comma-separated list of field names to display in the lookup browse for the dynamic Lookup.
Data type: CHARACTER
Note: Read and Write.
BrowseFieldFormats
Pipe-delimited list of field formats that correspond to the BrowseFields properties. These formats are assigned to the fields in the browser being used for the dynamic Lookup browserValue of BrowseFieldFormats.
Data type: CHARACTER
Note: Read and Write.
BrowseFields
List of fields to display in the browse when the viewAs property is set to browse.
Data type: CHARACTER
Note: Read and Write.
BrowseTitle
Title to display in the browse SmartWindowContainer when the ViewAs property is set to browse.
Data type: CHARACTER
Note: Read and Write.
BuildSequence
Used for dynamic Combos to determine the order in which to initialize a dynamic Lookup. This property allows you to use of the Parent filter query option when you have a dynamic Combo that is a parent for another dynamic Combo.
Data type: INTEGER
Note: Read and Write.
CancelBrowseOnExit
Controls whether or not to select the value in the browse on exit. If TRUE, the value in the browse is NOT to be selected on exit.
Data type: LOGICAL
Note: Read and Write.
ChangedEvent
Optional event to publish on value-changed.
Data type: CHARACTER
Note: Read and Write.
ComboDelimiter
Property assigned at runtime that contains the delimiter assigned to a dynamic Combo.
Data type: CHARACTER
Note: Read and Write.
ComboFlag
Property that allows you to specify options for a dynamic Combo. You can specify the following for this property:
*Blank — If a dynamic Combo should only contain the data retrieved from the BaseQueryString.
*A — If the dynamic combo allows the user to select a value of <All>.
*N — If the dynamic combo allows the user to select a value of <None>.
If the value for this property is A or N, the ComboFlagValue property must also have a value.
Data type: CHARACTER
Note: Read and Write.
ComboFlagValue
The value for this property is used to assign a value to a record when the user selects either All or None for a dynamic combo. This property contains a value only when the ComboFlag property has a value of A or N.
Data type: CHARACTER
Note: Read and Write.
ComboHandle
The value for this property is available only at run time and contains the handle of the combo-box of a dynamic Combo.
Data type: HANDLE
Note: Read and Write.
ComboQuery
Used to pass the query required by this combo back to the viewer for building. Once built, the query is returned into the procedure displayCombo.
Data type: HANDLE
Notes:  
*Read only.
*This design facilitates all combo queries being built with a single AppServer hit. It is published in the viewer.
*This function is not run in add mode.
*This function is published from displayFields in the viewer.
ComboSort
Sort property for the Combo.
Data type: LOGICAL
Note: Write only.
CurrentDescValue
The value for this property is available only at run time and contains a description of the currently selected option in a dynamic Combo. Basically, this is the current SCREEN-VALUE of the dynamic Combo.
Data type: CHARACTER
Note: Read and Write.
CurrentKeyValue
The value for this property is available only at run time and contains the current key value for the selected option. The value of this property is the same as getting the DataValue of the dynamic Combo.
Data type: CHARACTER
Note: Read and Write.
DataModified
Indicates whether SmartDataField value has changed but not saved. If TRUE, the field has changed and saved. If FALSE, the filed has changed but not saved.
Data type: LOGICAL
Note: Read and Write.
DataSourceFilter
This property is an optional filter expression for the data source.
Data type: CHARACTER
Note: Read and Write.
DataValue
This property is used by the SmartDataViewer when it collect changes using collectChanges.
Data type: CHARACTER
Notes:  
*Read and Write.
*If it encounters this PROCEDURE in the list of EnabledHandles and the DataModified property of this object equals TRUE.
DefineAnyKeyTrigger
Controls whether or not a persistent trigger is to be defined on ANY-KEY. TRUE if a persistent trigger is defined. Does not use the {get} syntax.
Data type: LOGICAL
Note: Read and Write
DescSubstitute
Property that stores the sequence for displaying the fields specified in the DisplayedField property list in a dynamic Combo. For example, &1 (&2) displays the value of the first field specified in DisplayedField and then concatenates that value with the value of the second field.
Data type: CHARACTER
Note: Read and Write.
DisplayDataType
Property that stores the data type of DisplayField for both the dynamic Lookup and dynamic Combo.
Data type: CHARACTER
Note: Read and Write.
DisplayField
Determines whether or not the SmartDataField is to be displayed along with other fields in its Contain. If TRUE, the SmartDataField is to be displayed. If FALSE, the SmartDataField is not to be displayed.
Data type: CHARACTER
Note: Read and Write.
DisplayFormat
This property stores the format for DisplayedField for both the Dynamic Lookup and Dynamic Combo.
Data type: CHARACTER
Note: Read and Write.
DisplayValue
Saved screen or display value of a SmartDataField. DisplayValue is based on the DataValue. If the keyfield and displayfield are the same, the keyfield value (datavalue) is returned. If they are not the same, then if a reposition source is set, it returns the displayedfield value that is obtained from the SDO. In all other cases it searches the list-item-pairs (or radio-buttons for radio-sets) given the datavalue and will return the display value.
Data type: CHARACTER
Note: Read and Write.
EdgePixels
Number of pixels that should be used to draw the rectangle around the buttons on a SmartPanel.
Data type: INTEGER
Note: Read and Write.
EnableField
Determines whether or not the SmartDataField is to be enabled for user input along with other fields in its Container. TRUE if the SmartDataField is to be enabled for user input along with other fields in its Container, otherwise FALSE.
Data type: CHARACTER
Note: Read and Write.
EnableOnAdd
Value of EnableOnAdd.
Data type: LOGICAL
Note: Read and Write.
ExitBrowseOnAction
Determines whether or not the selection of a value in the browse should also Exit the browse. TRUE if the selection of a value in the browse should Exit.
Data type: LOGICAL
Note: Read and Write.
FieldEnabled
Determines whether or not the SmartDataField is enabled for user input. TRUE if the SmartDataField is enabled, otherwise FALSE.
Data type: LOGICAL
Note: Read and Write.
FieldHidden
Hides or unhides a lookup field.
Data type: LOGICAL
Note: Read only.
FieldLabel
Label to use for the specified field.
Data type: CHARACTER
Note: Read and Write.
FieldName
Name of the SDO field to which this object maps.
Data type: CHARACTER
Note: Read and Write.
FieldToolTip
Text used for a tool tip for the specified field.
Data type: CHARACTER
Note: Read and Write.
FlagValue
Option flag key values for All and None.
Data type: CHARACTER
Note: Read and Write.
Format
An overridden format string.
Data type: CHARACTER
Note: Read and Write.
HelpId
Optional HelpId of the selection.
Data type: INTEGER
Note: Read and Write.
InnerLines
Option flag key values for All and None.
Data type: INTEGER
Note: Read and Write.
KeyDataType
Property that stores the data type for the KeyField for both the dynamic Lookup and dynamic Combo.
Data type: CHARACTER
Note: Read and Write.
KeyField
Name of the field whose value is either received or retrieved from the SmartDataViewer using the value in DataValue. For more information, see DataValue.
Data type: CHARACTER
Note: Read and Write.
KeyFormat
Property that stores the KeyField format for both the dynamic Lookup and dynamic Combo.
Data type: CHARACTER
Note: Read and Write.
Label
Label defined for the selection. If the value is undefined, it is converted to a string.
Data type: CHARACTER
Note: Read and Write.
LabelHandle
Property value that is available only at run time and contains the handle of the lookup FILL-IN's handle of a dynamic Lookup.
Data type: HANDLE
Note: Read and Write.
LinkedFieldDataTypes
Property that identifies the Data Types of Linked Fields to display in a viewer when a user selects a value in a dynamic Lookup. These values are comma-separated.
Data type: CHARACTER
Note: Read and Write.
LinkedFieldFormats
Property that identifies the Formats of Linked Fields to display in viewer when a user selects a value in a dynamic Lookup. These values are pipe-delimited.
Data type: CHARACTER
Note: Read and Write.
ListItemPairs
Property value that is available only at run time and contains the current list-item-pairs of a selected dynamic Combo.
Data type: CHARACTER
Note: Read and Write.
LookupFilterValue
Property value that is valid only at run time and contains the last value of a dynamic Lookup when the user presses the lookup button or the shortcut-key. You use this value to filter the values returned in the lookup browse.
Data type: CHARACTER
Note: Read and Write.
LookupHandle
Property value that is available only at run time and contains the handle of the FILL-IN of a dynamic Lookup.
Data type: HANDLE
Note: Read and Write.
LookupImage
Property that contains a relative-path name of the image to display on the lookup button.
Data type: CHARACTER
Note: Read and Write.
LookupQuery
Passes the query required by this lookup back to the viewer for building. Once built, the query is returned into the procedure displayLookup.
Data type: CHARACTER
Notes:  
*Read only.
*The query is published from displayfields in the viewer to facilitate all lookup queries being built with a single AppServer hit.
*This routine is not run at all in add mode.
MaintenanceObject
Represents the logical object name for the lookup to be launched when allowing maintenance.
Data type: CHARACTER
Note: Read and Write.
MaintenanceSDO
Name of the SDO to launch when allowing maintenance for the lookup.
Data type: CHARACTER
Note: Read and Write.
NumRows
Number of rows to display in the selection widget.
Data type: INTEGER
Note: Read and Write.
Optional
Indicates whether or not the selection is optional, and as a result, the property OptionalString holds the value to display. TRUE if the selection is optional and the property OptionalString holds the value to display.
Data type: LOGICAL
Note: Read and Write.
OptionalBlank
Determines whether or not the optional value is a blank value. TRUE if the optional value is a blank value.
Data type: LOGICAL
Notes:  
*Read and Write.
*Applies to character fields only.
OptionalString
Displays an optional value when the Optional property is set to TRUE.
Data type: CHARACTER
Note: Read and Write.
ParentField
Parent field name of the parent dependent object of a Combo or Lookup.
Data type: CHARACTER
Note: Read and Write.
ParentFilterQuery
Foreign fields of the parent object.
Data type: CHARACTER
Note: Read and Write.
PopupOnAmbiguous
Property used to determine whether or not a Lookup Browse should automatically open when the results of a search string are ambiguous.
Use this property to open a Lookup Browse when the search string is modified and a match cannot be found because the search string is ambiguous. This is the default behavior.
Data type: LOGICAL
Note: Read and Write.
PopupOnUniqueAmbiguous
Property used to determine whether or not a Lookup Browse should automatically open when the results of a search string include multiple matches that are not unique but ambiguous.
Use this property to open a Lookup Browse when the search string returns multiple matches that are unique but ambiguous. For example, if you search for “John”, all instances of “John” are found, but instances that begin with “John”, such as “Johnson”, are also found.
Data type: LOGICAL
Note: Read and Write.
PopupOnNotAvail
Property used to determine whether or not a Lookup Browse should automatically open when an exact match cannot be found for a search string.
Use the property to open a Lookup Browse when an exact match cannot be found.
Data type: LOGICAL
Note: Read and Write.
QueryTables
Property that contains a comma-separated list of tables used in the BaseQueryString of a dynamic Lookup or Combo.
Data type: CHARACTER
Note: Read and Write.
RefreshList
Comma-separated list of the names of the Dynamic Combos to be refreshed for the parent Combo named in the argument.
Data type: CHARACTER
Note: Read only.
RepositionDataSource
Determines whether or not the data-source is to be repositioned on valueChanged of the select. TRUE if the data-source is to be repositioned.
Data type: LOGICAL
Notes:  
*Read and Write.
*This is not needed for the view-as browse option.
*This must be set to TRUE if, for example, the data-source also is a data-source for other objects, and those objects need to be refreshed when a value is changed in the combo-box.
RowsToBatch
Number of records read in a single operation.
Data type: INTEGER
Note: Read and Write.
SavedScreenValue
Replaced by DisplayValue (which it calls). Property is used for backwards compatibility.
Data type: LOGICAL
Note: Read and Write.
SDFFileName
Property that contains the name of the SmartObject for the Lookup or Combo when you save a dynamic Lookup or Combo to the Repository. You can use this property to identify the object in the Repository when you want to make modifications.
Data type: CHARACTER
Note: Read and Write.
SDFTemplate
Property used to save the name of the SmartDataField (SDF) when a dynamic Combo or dynamic Lookup is created using an existing SDF from the Repository.
Data type: CHARACTER
Note: Read and Write.
Secured
Determines whether or not the combo’s security is set to HIDDEN. TRUE, if the combo’s security is set to HIDDEN.
Data type: LOGICAL
Note: Read and Write.
StartBrowseKeys
List of Keylabels or KeyFunctions that starts the browse.
Data type: CHARACTER
Note: Read and Write.
ToolTip
Optional ToolTip for the selection.
Data type: CHARACTER
Note: Read and Write.
UsePairedList
Checks to see if an object is an editable combo-box. If getUsePairedList determines the object is an editable combo-box, it returns FALSE, indicating a paired list cannot be used.
Data type: LOGICAL
Note: Read only.
ViewAs
Definition of the selection: combo-box, radio-set, selection-list, or browse. Uses a colon as a separator to define SUB-TYPE for combo-box or horizontal/vertical radio-set. For example: radio-set:vertical.
Data type: CHARACTER
Note: Read and Write.
ViewerLinkedFields
A comma-separated list of fields that you want returned when a value is selected in a dynamic Lookup. You can then use these values either to fill selected fields on a viewer or as references to values required by the developer.
Data type: CHARACTER
Note: Read and Write.
ViewerLinkedWidgets
If the ViewerLinkedFields attribute contains a value and the values returned from these fields should be automatically filled on a viewer when a value was selected in a dynamic Lookup, then this attribute would contain a comma-separated list of widget names on the viewer where these values should be filled in.
Data type: CHARACTER
Note: Read and Write.