Field_GetColor()

Examples


The Field_GetColor() function retrieves color information for a field.

Syntax

Field_GetColor(field, font_color, back_color, pattern_color, pattern)

Parameters

field – The field for which color information will be retrieved.

font_color – A return long integer containing the font color. The value corresponds to one of the following constants:

[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

 


back_color – A returned long integer containing the back color. The value corresponds to one of the constants listed for font_color.

pattern_color – A returned long integer containing the pattern color. The value corresponds to one of the constants listed for font_color.

pattern – A returned integer containing the pattern. The value corresponds to one of the following constants:

[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

A boolean. True indicates color information was retrieved, while false indicates it was not.


Documentation Feedback