TextFrameGetBackColor

Description

Returns 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.

Applies to

RichTextEdit control

Syntax

long rtename.TextFrameGetBackColor(integer textFrameID)

Argument

Description

textFrameID

The unique ID that identifies the text frame.


Return value

Long.

Returns the background color of the specified text frame if it succeeds. The RichTextEdit control uses the Microsoft Windows operating environment red-green-blue (RGB) color scheme.

Returns -1 if it fails. Returns null if any argument is null.

Examples

The following example gets the back color of the specified text frame.

integer li_frameid
long ll_rtn

li_frameid = rte_1.TextFrameInsertAsChar(-1,5000,1000)
ll_rtn = rte_1.TextFrameGetBackColor(li_frameid)