CDTextSetBoxEdgeColor < Main

Tags: view all tags
---+ .TEXT SET BX EDGE CLR

_This subroutine sets the edge color for the "current" Text Object_ _._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;color_spec_name&gt;          FIELD            SHARE? N
      *        OR
      PASS         &lt;color_value&gt;              FIELD            SHARE? N
      GOSUB    0CD .TEXT SET BX EDGE CLR
      *        Check for error
      IF       0CD .TEXT SET BX EDGE CLR      NE
</pre>
---++ Description:

This subroutine sets the edge color for the "current" Text Object. Every text object is contained in a box. This allows you to set the edge color of the text box. This routine receives one optional value specifying either a &lt;color_spec_name&gt; or a &lt;color_value&gt;.

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

If a parameter is received, the system first assumes that the value received is a &lt;color_spec_name&gt; 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 edge color. If a color spec record is not found, then the system assumes that the value received is a literal &lt;color_value&gt; and uses the specified color to create a color spec for the edge color.

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

Also see [[CDTextSetBoxEdgeWidth][.TEXT SET BX EDGE W]] to set the edge width and [[CDTextSetBoxEdgeEffect][.TEXT SET BX EDGE EFF]] to set the edge effect.

See ColorSpec for more information on working with colors.
---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2011-11-17
Topic revision: r2 - 2012-02-22 - JeanNeron