CDAxisSetTitle < Main

Tags: view all tags
---+ .AXIS SET TITLE

_This subroutine is called to set the title for the "current" axis._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;axis_title&gt;               FIELD            SHARE? N
      PASS         &lt;text_box_name&gt;            FIELD            SHARE? N
      GOSUB    0CD .AXIS SET TITLE
      *        Check for error
      IF       0CD .AXIS SET TITLE            NE
</pre>
---++ Description:

This subroutine sets the title for the "current" axis. You must have selected a "current" axis via [[CDAxisSetCurrent][.AXIS SET CURRENT]] before calling this routine. This subroutine only needs to be called if the axis is to have a title or if a previously set axis title is to be changed or removed.

&lt;axis_title&gt; is the text string which will be rendered as the axis title in a text box. The location of the text box will be determined by whether you selected Primary or Secondary when setting the "current" axis. The &lt;axis_title&gt; parameter is optional.
   * If a non-blank &lt;axis_title&gt; is passed, then a title is set for the "current" axis. If a title has been previously set, then that title is replaced.
   * If a &lt;axis_title&gt; is not passed or if a blank title is passed, then no title is set. If a title has been previously set, then that title is cleared along with all of the related axis title attributes.

&lt;text_box_name&gt; is the name of a previously initialized text box. The &lt;text_box_name&gt; parameter is optional.
   * If a &lt;text_box_name&gt; is passed, then the attributes of the specified text box are used as a prototype for the attributes of the &lt;axis_title&gt;. Two special keywords may be used in lieu of a &lt;text_box_name&gt;: "INITIALIZE" and "CURRENT" 
      * "INITIALIZE" indicates that the axis title is to be set and no special title attributes are to be set. Any previously set title attributes are to be cleared.
      * "CURRENT" indicates that the axis title is to be set and the attributes of the "current" text box are to be used as a prototype for the attributes of the &lt;axis_title&gt;.
   * If a &lt;text_box_name&gt; is not passed, then the following rules determine how the attributes of the axis title are set: 
      * If the axis title has been previously set, then the new axis title is set and any previously set attributes of the axis title are not changed.
      * If the axis title has not been previously set, then the attributes of the "current" text box will be used as a prototype for the attributes of the &lt;axis_title&gt; provided that the "current" text box has been explicitly initialized or is associated with another axis's title. If the "current" text box is not appropriate, then no attributes of the &lt;axis_title&gt; will be set in conjunction with setting the axis title.

If no attributes are set for a axis title, the title is rendered using certain default text attributes which are appropriate for a axis title.

The axis title text box become the "current" text box and subsequent calls to the various text subroutines may be made to further set/modify the text attributes of the axis title.
---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2011-11-10
Topic revision: r2 - 2012-02-25 - JeanNeron