BBjColor::getRed

Description

Returns the red value of a BBjColor object.

Syntax

Return Value

Method

int

getRed()

Parameters

None.

Return Value

Returns the red value of a BBjColor object.

Remarks

The value can be in the range 0-255.

Example

REM Get the red value from an instance of a BBjColor object

REM Obtain the instance of the BBjAPI object
LET myAPI!=BBjAPI()

REM Open the SysGui device
SYSGUI=UNT
OPEN (SYSGUI) "X0"

REM Obtain the instance of the BBjSysGui object
LET mySysGui!=myAPI!.getSysGui()

REM Create the BBjColor Object using RGB values
myColorRGB! = mySysGui!.makeColor(215,255,100)

REM Get the red value from the BBjColor object, this will return 215
RED_VALUE = myColorRGB!.getRed()

See Also

BBjAPI

BBjSysGui

Object Variables

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.