Field_SetZoomFormat()

The Field_SetZoomFormat() function sets the display characteristics of text and field objects (string, currency, integer, long, date and time) whose Zoom property is true.

Syntax

Field_SetZoomFormat(font_underline, font_color)

Parameters

• font_underline – A boolean specifying whether a line appears beneath the text or field object. If true, the item will appear underlined.

• font_color – A long integer specifying the color of the text or field object. Use the following constants:

Constant	Constant
COLOR_SYSTEM	COLOR_TEAL
COLOR_TRANSPARENT	COLOR_GREEN
COLOR_BLACK	COLOR_DARK_YELLOW
COLOR_WHITE	COLOR_VIOLET
COLOR_RED	COLOR_DARK_RED
COLOR_BRIGHT_GREEN	COLOR_DARK_BLUE
COLOR_BLUE	COLOR_MEDIUM_GRAY
COLOR_TURQUOISE	COLOR_LIGHT_GRAY
COLOR_PINK	COLOR_LIGHT_YELLOW
COLOR_YELLOW

Return value

The boolean value true.

Comments

For text objects used for prompts, use these visual indicators to indicate the presence of a zoom field. The following illustration shows one way a zoom field’s prompt can look:

Don’t confuse the Zoom property for field and text objects with the Zoom property for push buttons. When set to true, the Zoom property for push buttons displays a different mouse pointer, indicating the presence of a zoom field.

The Field_SetZoomFormat() 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 “Zoom”. 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 searches for all prompts that appear beneath zoom buttons and sets each prompt’s Zoom property to true. Once you’ve converted your application’s user interface using this utility, use this function to specify the characteristics of zoom field prompts throughout your application. If you don’t use this function, zoom field prompts will automatically appear with an underline and a black font color.