Text SetBGColor

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Assigns the specified background color to a text object with the specified ID number.

Text_SetBGColor returns a value of 0 if the color was successfully assigned and a value of -2 if the specified object ID number is invalid.

Usage

Text_SetBGColor(ObjectID, BGColor)

Parameters

ObjectID - a numerical expression specifying the object ID number.

BGColor - an expression specifying the background color.

The color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words.

Notes

An object-specific ID number is returned by Text_New when the text object is created.
Use Text_GetBGColor to get the background color for a specific text object.

Example

Assign the color blue to the background of a text object with the ID number of 3:

Value1 = Text_SetBGColor(3, Blue);

Assign the RGB color 2138336 (Orange) to the background of a text object with the ID number of 3:

Value1 = Text_SetBGColor(3, 2138336);

Assign the legacy color 4 (Green) to the background of a text object with the ID number of 3:

[LegacyColorValue = True];

Value1 = Text_SetBGColor(3, 4);