Field_SetCustomPromptFormat()

The Field_SetCustomPromptFormat() function sets the display characteristics for all text and field objects in an application whose BackColor, FontColor, PatternColor and Pattern properties are Custom.

Syntax

Field_SetCustomPromptFormat(back_color, font_color, pattern_color, pattern)

Parameters

• back_color – A long integer speciying the back color of the object. Use the following constants to set the back color:

• font_color – A long integer specifying the font color of the object. Use the constants listed above to set the font color.

• pattern_color – A long integer specifying the pattern color of the object. Use the constants listed above. COLOR_SYSTEM is not valid for this parameter.

• pattern – An integer specifying the pattern of the object. Use the following constants to set the pattern:

Return value

The boolean value true.

Comments

The Field_SetCustomPromptFormat() function automatically adds several entries to the defaults file for your application. These entries store the characteristics that were just specified, and begin with the word “Custom”. If these entries exist in the defaults file, Dexterity or the runtime engine will automatically apply them when your application is run.

The User Interface Conversion Utility in Dexterity Utilities changes the BackColor, FontColor, Pattern and PatternColor properties for an application’s prompts (text objects that appear within a cyan rectangle that’s 18 pixels high) to Custom. The utility leaves properties for all other text objects unchanged.

If you don’t use the Field_SetCustomPromptFormat() function, objects that use the Custom setting for BackColor, FontColor, Pattern and PatternColor properties will appear with the following set of default display characteristics:

These defaults do not apply to static text items for controls such as push buttons, check boxes and radio buttons. Your operating system color settings control the display characteristics for those objects if you chose the Use System Colors option in the User Interface Application Utility.

Documentation Feedback

---