Member variable XbpRtf():selColor Foundation

Contains the color used to display the text in the XbpRtf object.

Attribute: EXPORTED
Data type: Numeric (GRA_CLR_BLACK)

The property contains a color value that specifies the color for displaying the text within the current selection. If no text is currently selected, the color is changed for all text entered after the current insertion point.

To define the color for displaying text, an application can use one of the pre-defined color constants defined in GRA.CH (GRA_CLR_xxx) or a system color defined in XBP.CH (XPBSYSCLR_xxx). Alternatively, the function GraMakeRGBColor()can be used to create a custom color value from an RGB specification. Regardless of which method is used, the color value is always converted to an RGB-encoded color value. See the GraGetRGBIntensity() for information on how to interpret such a color value.

If the text in the current selection contains sections using a different color, the instance variable :selColor contains the value NIL. This value represents an indeterminate state that the Xbase++ application may chose to visualize in its user interface. Some word processor applications use grayed controls to visualize conflicting properties in the current selection, for example.

NIL is a valid value for reading only. A run time error results, if an attempt is made to assign NIL to the :selColor instance variable.


If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.