CDLineSetClr < Main

---+ .LINE SET CLR

<em>This subroutine sets the color of the "current" </em>line object<em>.</em>

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

</pre>
---++ Description:

This subroutine sets the color of the "current" line object.

<div id="_mcePaste">This routine receives a single, optional value specifying either a &lt;color_spec_name&gt; or a &lt;color_value&gt;.</div>

<div id="_mcePaste">If a parameter is not received or if the value received is blank, then the color of the line object is cleared and the default color will be rendered.</div>

<div id="_mcePaste">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 line 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 line color.</div>

<div id="_mcePaste">See ColorSpec for more information on working with colors.</div>

---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2012-02-17

This topic: Main > WebHome > APPX510Features > CDChartDirectorDesignerAPI > CDChartDirectorBaseChartRoutines > CDLineSetClr
Topic revision: r1 - 2012-02-17 - JeanNeron