InsertAttrRGB Method (LISTVIEW)

9.0, PLBCMP GUI Only

The InsertAttrRGB method initializes the color index table for the LISTVIEW object using COLOR objects. The LISTVIEW color table allows definition of up to twenty (20) colors. The method uses the following format:

[label]	{object}.InsertAttrRGB	[GIVING {return}] USING [RGB1=]{rgb*}:
		[RGB2=]{rgb*}:
		...
		[RGB20=]{rgb*}:
		[Flags={flags*}]

Where:

label

Optional. A Program Execution Label.

object

Required. A LISTVIEW object that is accessed.

return

Optional. A Numeric Variable that indicates the first table position modified.

rgb

Optional. A Character String Variable, literal, numeric variable or decimal or hex value that defines an RGB value.

flags

Optional. A numeric value that controls the operations of the method.

Flags Affected: OVER, ZERO

Note the following:

The LISTVIEW color table allows definition of twenty (20) colors.
The format of the hexadecimal string must be given as "0xRRGGBB" representing the red/green/blue value of the color. The character values of the 'R', 'G', and 'B' characters must be from zero (0) to 'F'.
If a value is stored into the color table, the returned value is the first color table position that was set. If no color table positions were set, a value of zero is returned.
The ZERO condition flag is set if the returned value is zero.
The OVER flag is set if the {return} variable is too small to hold the returned value.
The {flags} bit mask value is defined as follows:

Value	Operation
0x1	Convert all input {rgb} values from input BGR values to RGB values before they are stored as attribute colors. (9.3A)

For improved performance in the Application Server environment, do not specify the optional return value unless needed.