GetRelField
Mon 01 January 2018Syntax
GetRelField(ctrl_field, related_field)
Description
Use the GetRelField function to retrieve the value of a related display field and returns it as an unspecified (Any) data type.
Note: This function remains for backward compatibility only. Use the GetRelated field class method instead.
The field ctrl_field specifies the display control field, and related_field specifies the name of the related display field whose value is to be retrieved. In most cases, you could get the value of the field by referencing it directly. However, there are two instances where GetRelField can be useful:
-
If there are two related display fields bound to the same record field, but controlled by different display control fields, use this function to specify which of the two related display fields you want.
-
If all of a pageâs level-zero fields are search keys, the Component Processor does not load the entire row of level-zero data into the component buffer; it only loads the search keys. Adding a non-search-key level-zero field to the page would cause the Component Processor to load the entire row into the component buffer. To prevent a large row of data from being loaded into the buffer, you may occasionally want to make a level-zero display-only field a related display, even though the field is in the primary level-zero record. You wonât be able to reference this related display field directly, but you can using GetRelField.
See .