.TEXT SET BX BG CLR

This subroutine sets the background color for the "current" Text Object .

Usage:

      PASS         <color_spec_name>          FIELD            SHARE? N
      *        OR
      PASS         <color_value>              FIELD            SHARE? N
      GOSUB    0CD .TEXT SET BX BG CLR
      *        Check for error
     IF       0CD .TEXT SET BX BG CLR        NE

Description:

This subroutine sets the background color for the "current" Text Object. Every text object is contained in a box. This allows you to set the background color in the text box. This routine receives one optional value specifying either a <color_spec_name> or a <color_value>.

If a parameter is not received or if the value received is blank, then the background color of the text object is cleared and the default background color will be rendered.

If a parameter is received, the system first assumes that the value received is a <color_spec_name> and checks to see if a color spec record has been previously initialized with that name. If a color spec record is found, then that color spec record is used as a prototype to create a color spec for the background color. If a color spec record is not found, then the system assumes that the value received is a literal <color_value> and uses the specified color to create a color spec for the background color.

After setting the background color, the background color spec becomes the "current" color spec.

See ColorSpec for more information on working with colors.

Comments:

Read what other users have said about this page or add your own comments.

-- JeanNeron - 2011-11-17