Description
Sets the background color of a text frame in the RichTextEdit control. The RichTextEdit control uses the Microsoft Windows operating environment red-green-blue (RGB) color scheme. The valid range for a RGB color is 0 to &HFFFFFF. The high byte of a number in this range equals 0; the lower 3 bytes, from least to most significant byte, determine the amount of red, green, and blue, respectively. The red, green, and blue components are each represented by a number between 0 and 255 (&HFF).
Applies to
Syntax
boolean rtename.TextFrameSetBackColor(integer textFrameID, long color)
|
Argument |
Description |
|---|---|
|
textFrameID |
The unique ID that identifies the text frame. |
| color | The background color of the text frame. The RichTextEdit control uses the Microsoft Windows operating environment red-green-blue (RGB) color scheme. The valid range for a RGB color is 0 to &HFFFFFF. The high byte of a number in this range equals 0; the lower 3 bytes, from least to most significant byte, determine the amount of red, green, and blue, respectively. The red, green, and blue components are each represented by a number between 0 and 255 (&HFF). |
Return value
Boolean.
Returns true if it succeeds. Returns false if it fails. Returns null if any argument is null.
Examples
The following example sets the specified text frame to use gray background color (#808080).
integer li_frameid boolean lb_rtn li_frameid = rte_1.TextFrameInsertAsChar(-1,5000,1000) lb_rtn = rte_1.TextFrameSetBackColor(li_frameid,#808080)
