SetRichTextColor

Description

Sets the color to use while editing columns with the RichText edit style.

Applies to

DataWindow control

Syntax

Integer dwcontrol.SetRichTextColor ( long color )

Argument

Description

dwcontrol

A reference to the DataWindow control

color

A long value specifying the color that you want to set for editing columns with the RichText edit style


Return value

Returns 0 if it succeeds and -1 if an error occurs. If the argument's value is null, SetRichTextColor returns null.

0 -- Success

-1 -- No RichText column is being edited

Usage

If the color for columns with the RichText edit style is white, background transparency and gradient and text transparency will not work properly.

You can call this method from a button in a custom toolbar that you use to set display characteristics of columns with the RichText edit style.

Examples

This example sets green as the current color to use for editing columns that have a RichText edit style:

Integer l_rtn
Long l_color
l_color = RGB(0, 255, 0)
l_rtn = dw_1.SetRichTextColor(l_color)

See also

GetRichTextColor

GetRichTextAlign

GetRichTextFaceName

GetRichTextSize

GetRichTextStyle