OPTIONCAPTION Function (FieldRef)

Gets the option caption of the field that is currently selected.


OptionCaption := FieldRef.OPTIONCAPTION  


Type: FieldRef

Refers to the current field.

Property Value/Return Value

Type: Text

The option caption of the field.


The option caption of the field is returned as a comma separated string.

If the field is not an Option, an empty string is returned.

This function returns an error if no field is selected.


The following example opens the Item table as a RecordRef variable that is named ItemRecref. and creates a reference to field 19 (Price/Profit Calculation field), which is an Option field. The OPTIONCAPTION function retrieves the caption of the option field and displays the options as a comma separated list. This example requires that you create the following variables in the C/AL Globals windows.

Variable name DataType
ItemRecref RecordRef
MyFieldRef FieldRef
OptionCaption Text
MyFieldRef := ItemRecref.FIELD(19);  
OptionCaption := MyFieldRef.OPTIONCAPTION;  
MESSAGE('%1', OptionCaption);  

See Also

FieldRef Data Type