CDLegendSetKeyIconEdgeColor < Main

---+ .LEGEND SET ICON E CLR

_This subroutine sets the icon edge color of the "current" chart spec._

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

This subroutine set the edge colors of the icons in your legend (retangular icons only). This routine receives a single, 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 icons 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 icon edge color. If a color spec record is not found, then the system assumes that the value received is a literal <strong>&lt;color_value&gt;</strong>and uses the specified color to create a color spec for the background color.

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

You have to define a Legend box via [[CDChartSetLegendBox][.CHART SET LEGEND BOX]] for this subroutine to have any 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-09-27

This topic: Main > WebHome > APPX510Features > CDChartDirectorDesignerAPI > CDChartDirectorBaseChartRoutines > CDLegendSetKeyIconEdgeColor
Topic revision: r3 - 2012-02-19 - JeanNeron