GetRichTextColor

Description

Gets the current color setting for editing columns with the RichText edit style.

Applies to

DataWindow control

Syntax

Integer dwcontrol.GetRichTextColor ( REF long color )

Argument

Description

dwcontrol

A reference to the DataWindow control

color

A long used to define the color


Return value

Returns an integer to indicate whether the column that you selected has the RichText edit style and whether the content has one or more colors applied.

0 -- Success

-1 -- No RichText column is being edited

-2 -- The selected text is a mix of colors

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 obtain current font settings for columns with the RichText edit style.

Examples

This example obtains the current color setting of the font to be used for editing columns with a RichText edit style:

Integer li_integer
Long l_long
li_integer = dw_1.GetRichTextColor(l_long)

See also

GetRichTextAlign

GetRichTextFaceName

GetRichTextSize

GetRichTextStyle

SetRichTextColor