Field_SetRequiredStatus()

Examples


The Field_SetRequiredStatus() function either checks or unchecks the Show Required Fields menu item.

Syntax

Field_SetRequiredStatus(mode)

Parameters

mode – A boolean that sets one of the following options:

[spacer]

Value

Description

true

Sets the Show Required Fields menu item to checked.

false

Sets the Show Required Fields menu item to unchecked.


Return value

Boolean. The value returned denotes the status of the Show Required Fields menu item before if it was changed using this function.

Comments

When the Show Required Fields menu item is checked, the prompts linked to required fields in a window will be displayed as defined by the Field_SetRequiredFormat() function.

This function can be used in your application’s Main Menu pre script to set the Show Required Fields menu item to the status stored in a user preferences table. Conversely, it can be used in the Main Menu post script to ascertain whether the Show Required Fields menu item was checked, so that the information could be saved in a user preferences table.


Documentation Feedback