Skip to content

Retainall Field Property

Obsolete

Refer to the Field Options property in the DataDictionary class.

See Also

Purpose

To keep data in an item as an aid to data entry through all clearing operations.

Syntax

set field_options field file.field to dd_retainall

or

entry_item file.field [
    {retainall
    [..., option]
    }
]

What It Does

When retainall is on an entry_item, it prevents clearing of the contents of the item by such messages as entry_clear and entry_clear_all, or by pressing the Clear Panel or Clear All Panels accelerator keys.

entry_item this_co.name {retainall}

In this example, data shown through the item attached to Fieldname in Filethis_co is retained in the item regardless of how many times the Clear Panel key is pressed.

Field properties may be applied to fields using the field_options property in the construct_object procedure of a DataDictionary object.

set field_options field this_co.name to dd_retainall

In this example, every DEO with an item addressing Fieldname in Filethis_co and using the DataDictionary in which this line is coded will apply the dd_retainall field property to such item.

Notes

  • Even though users cannot clear the item with Clear Panel, they still may erase it manually (character-by-character).

  • If you want to be able to clear the item by pressing Clear Panel, use the retain field property.