Field_SetAltLineColor()

Examples


The Field_SetAltLineColor() function specifies colors for alternate lines in scrolling windows whose AltLineColor property is true and whose BackColor, FontColor, Pattern and PatternColor properties are Custom.

Syntax

Field_SetAltLineColor(back_color, font_color, pattern_color, pattern)

Parameters

back_color – A long integer specifying the back color of the scrolling window line. Use the following constants to set the back color:

[spacer]

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

 


font_color – A long integer specifying the font color of the scrolling window line. Use the constants listed above to set the font color.

pattern_color – A long integer specifying the pattern color of the scrolling window line. Use the constants listed above to set the pattern color.

pattern – An integer specifying the pattern of the scrolling window line. Use the following constants to set the pattern:

[spacer]

Constant

Pattern

Constant

Pattern

PATTERN_NONE

PATTERN_VERTICAL

PATTERN_25_SHADING

PATTERN_UP_DIAGONAL

PATTERN_50_SHADING

PATTERN_DOWN_DIAGONAL

PATTERN_75_SHADING

PATTERN_GRID

PATTERN_HORIZONTAL

PATTERN_TRELLIS


Return value

The boolean value true.

Comments

The Field_SetAltLineColor() 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.

You can use the User Interface Conversion Utility in Dexterity Utilities to update your application to use custom colors for scrolling windows. Mark the Use Custom Colors for Scrolling Windows option when you run the utility. The utility will set the AltLineColor property to true, and the BackColor, FontColor, Pattern and PatternColor properties to Custom for all scrolling windows in your application.

If you don’t use the Field_SetAltLineColor() function, scrolling windows whose AltLineColor property is true will appear with the following set of default display characteristics:

[spacer]

Attribute

Default display

Back color

System

Font color

System

Pattern

None

Pattern color

White



Documentation Feedback