4D v14.3

OBJECT GET RGB COLORS

Home

 
4D v14.3
OBJECT GET RGB COLORS

OBJECT GET RGB COLORS 


 

OBJECT GET RGB COLORS ( {* ;} object ; foregroundColor {; backgroundColor {; altBackgrndColor}} ) 
Parameter Type   Description
Operator in If specified, object is an object name (string) If omitted, object is a variable or a field
object  Form object in Object name (if * is specified) or Variable or field (if * is omitted)
foregroundColor  Longint in RGB color value for foreground
backgroundColor  Longint in RGB color value for background
altBackgrndColor  Longint in RGB color value for alternating background

The OBJECT GET RGB COLORS command returns the foreground and background colors of the object or group of objects designated by object.

If you pass the optional * parameter, you indicate that the object parameter is an object name (string). If you do not pass this parameter, you indicate that the object parameter is a field or a variable. In this case, you pass a field or variable reference (object field or variable only) instead of a string. 

When the command is applied to a List box type object, the alternating background color for the rows can be returned in the altBackgrndColor parameter. In this case, the value of backgroundColor is used for the background of odd-numbered rows only. 

The RGB color values returned in the foregroundColor, backgroundColor and altBackgrndColor parameters can be 4-byte longints of the format (0x00RRGGBB) or negative values corresponding to the "system" colors. In the latter case, you can compare the value obtained with the constants of the SET RGB COLORS theme:

Constant Type Value Comment
Background color Longint -2
Background color none Longint -16 This constant can only be used with the backgroundColor and altBackgrndColor parameters.
Dark shadow color Longint -3
Disable highlight item color Longint -11
Foreground color Longint -1
Highlight menu background color Longint -9
Highlight menu text color Longint -10
Highlight text background color Longint -7
Highlight text color Longint -8
Light shadow color Longint -4

Note: The "system" colors are applied using the OBJECT SET RGB COLORS command.

For more information about the format of the foregroundColor, backgroundColor and altBackgrndColor parameters, refer to the description of the OBJECT SET RGB COLORS command.

 
PROPERTIES 

Product: 4D
Theme: Objects (Forms)
Number: 1074

 
HISTORY 

Created: 4D v12

 
SEE ALSO 

OBJECT SET RGB COLORS

 
ARTICLE USAGE

4D Language Reference ( 4D v12.4)
4D Language Reference ( 4D v14 R3)
4D Language Reference ( 4D v14 R2)
4D Language Reference ( 4D v13.5)
4D Language Reference ( 4D v14.3)
4D Language Reference ( 4D v14 R4)