253 lines
14 KiB
HTML
253 lines
14 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html lang="en-us" xml:lang="en-us">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="security" content="public" />
|
|
<meta name="Robots" content="index,follow" />
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
|
<meta name="DC.Type" content="concept" />
|
|
<meta name="DC.Title" content="BOX (Box) keyword in printer files" />
|
|
<meta name="abstract" content="Use this record-level keyword to print a rectangle." />
|
|
<meta name="description" content="Use this record-level keyword to print a rectangle." />
|
|
<meta name="DC.subject" content="BOX (Box) keyword" />
|
|
<meta name="keywords" content="BOX (Box) keyword" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzakdmstprkey.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzakdmstptcolor.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzakdmstpositn.htm" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2001, 2006" />
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2001, 2006" />
|
|
<meta name="DC.Format" content="XHTML" />
|
|
<meta name="DC.Identifier" content="rzakdmstptbox" />
|
|
<meta name="DC.Language" content="en-us" />
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
|
<title>BOX (Box) keyword in printer files</title>
|
|
</head>
|
|
<body id="rzakdmstptbox"><a name="rzakdmstptbox"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">BOX (Box) keyword in printer files</h1>
|
|
<div><p>Use this record-level keyword to print a rectangle.</p>
|
|
<div class="p">The format of the keyword is: <pre>BOX(first-corner-down | &first-corner-down-field
|
|
first-corner-across | &first-corner-across-field
|
|
diagonal-corner-down | &diagonal-corner-down-field
|
|
diagonal-corner-across | &diagonal-corner-across-field
|
|
line-width | &line-width-field
|
|
[color value]
|
|
[shading])</pre>
|
|
</div>
|
|
<p>The first-corner-down, first-corner-across, diagonal-corner-down, and diagonal-corner-across
|
|
parameters define the diagonal corners of the box. All are required parameters.</p>
|
|
<div class="p">You can specify the corner position parameters as constants,
|
|
program-to-system fields, or a combination of both, as shown in the following
|
|
lines: <ul><li>BOX(1.2 0.5 5.1 6.3 0.2)</li>
|
|
<li>BOX(1.2 &field2 5.1 &field4 0.2)</li>
|
|
<li>BOX(&field1 &field2 &field3 &field4 0.2)</li>
|
|
</ul>
|
|
</div>
|
|
<p>The first-corner-down parameter defines the vertical starting point of
|
|
the BOX relative to the margins specified on the FRONTMGN or BACKMGN parameter
|
|
of the CRTPRTF command. Valid values are 0 to 57.790 cm (0 to 22.750 in.).</p>
|
|
<p>When you specify the first-corner-down parameter as a program-to-system
|
|
field, the field must exist in the same record format as the BOX keyword.
|
|
It must be defined as length of 5 with 3 decimal positions, data type S (character),
|
|
and usage P (program-to-system).</p>
|
|
<p>The first-corner-across parameter defines the horizontal starting point
|
|
of the BOX relative to the margins specified on the FRONTMGN or BACKMGN parameter
|
|
of the CRTPRTF command. Valid values are 0 to 57.790 cm (0 to 22.750 in.).</p>
|
|
<p>When you specify the first-corner-across parameter as a program-to-system
|
|
field, the field must exist in the same record format as the BOX keyword.
|
|
It must be defined as length of 5 with 3 decimal positions, data type S (character),
|
|
and usage P (program-to-system).</p>
|
|
<p>The diagonal-corner-down parameter defines the vertical end point of the
|
|
BOX relative to the margins specified on the FRONTMGN or BACKMGN parameter
|
|
of the CRTPRTF command. Valid values are 0 to 57.790 cm (0 to 22.750 in.).</p>
|
|
<p>When you specify the diagonal-corner-down parameter as a program-to-system
|
|
field, the field must exist in the same record format as the BOX keyword.
|
|
It must be defined as length of 5 with 3 decimal positions, data type S (character),
|
|
and usage P (program-to-system).</p>
|
|
<p>The diagonal-corner-across parameter defines the horizontal end point of
|
|
the BOX relative to the margins specified on the FRONTMGN or BACKMGN parameter
|
|
of the CRTPRTF command. Valid values are 0 to 57.790 cm (0 to 22.750 in.).</p>
|
|
<p>When you specify the diagonal-corner-across parameter as a program-to-system
|
|
field, the field must exist in the same record format as the BOX keyword.
|
|
It must be defined as length of 5 with 3 decimal positions, data type S (character),
|
|
and usage P (program-to-system).</p>
|
|
<p>The line-width parameter is required and defines the width of the lines.
|
|
Valid values are 0.001 to 57.790 cm (0.001 to 22.750 in.). The following special
|
|
values can also be specified:</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><thead align="left"><tr valign="bottom"><th valign="bottom" width="33.33333333333333%" class="firstcol" id="d0e57">Value</th>
|
|
<th valign="bottom" width="66.66666666666666%" id="d0e59">Line width</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><th valign="top" width="33.33333333333333%" class="firstcol" id="d0e63" headers="d0e57 ">*NARROW</th>
|
|
<td valign="top" width="66.66666666666666%" headers="d0e63 d0e59 ">12/1440 in. (0.008 in., 0.022 cm)</td>
|
|
</tr>
|
|
<tr><th valign="top" width="33.33333333333333%" class="firstcol" id="d0e68" headers="d0e57 ">*MEDIUM</th>
|
|
<td valign="top" width="66.66666666666666%" headers="d0e68 d0e59 ">24/1440 in. (0.017 in., 0.042 cm)</td>
|
|
</tr>
|
|
<tr><th valign="top" width="33.33333333333333%" class="firstcol" id="d0e73" headers="d0e57 ">*WIDE</th>
|
|
<td valign="top" width="66.66666666666666%" headers="d0e73 d0e59 ">36/1440 in. (0.025 in., 0.064 cm)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p>When you specify the line-width parameter as a program-to-system field,
|
|
the field must exist in the same record format as the BOX keyword. It must
|
|
be defined as length of 5 with 3 decimal spaces, data type S (character),
|
|
and usage P (program-to-system). The special values of *NARROW, *MEDIUM, or
|
|
*WIDE cannot be specified using a program-to-system field.</p>
|
|
<div class="note"><span class="notetitle">Notes:</span> <ol><li>The UOM parameter on the CRTPRTF command determines the units of measure
|
|
for the first-corner-down, first-corner-across, diagonal-corner-down, diagonal-corner-across,
|
|
and line-width parameter values. If the value specified for a parameter is
|
|
outside the valid range, it is flagged when the spooled file is created.</li>
|
|
<li>Depending on printer hardware, lines smaller than approximately 0.004
|
|
in. (0.010 cm) might not print because of printer resolution. No message is
|
|
issued when this occurs.</li>
|
|
</ol>
|
|
</div>
|
|
<p>The line width is drawn on the inside of the box.</p>
|
|
<div class="section"><h4 class="sectiontitle">Color</h4><p>The optional color parameter lets you specify
|
|
the color of the lines. Specify the color as an expression in one of the following
|
|
forms:</p>
|
|
<ul><li>Color name method: <samp class="codeph">(*COLOR color-name)</samp></li>
|
|
<li>RGB (red/green/blue) color model: <samp class="codeph">(*COLOR *RGB rvalue gvalue bvalue)</samp></li>
|
|
<li>CMYK (cyan/magenta/yellow/black) color model: <samp class="codeph">(*COLOR *CMYK cvalue
|
|
mvalue yvalue kvalue)</samp></li>
|
|
<li>CIELAB color model: <samp class="codeph">(*COLOR *CIELAB lvalue c1value c2value)</samp></li>
|
|
<li>Highlight color model: <samp class="codeph">(*COLOR *HIGHLIGHT hvalue coverage)</samp></li>
|
|
</ul>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Shading</h4><div class="p">The optional shading parameter lets you
|
|
specify shading for the box. Specify the shading as expression in the following
|
|
form: <pre>(*SHADE coverage color)</pre>
|
|
The shading coverage specifies
|
|
how dark the shading should be. Specify the coverage as an integer from 0
|
|
to 100 that matches the percentage of shading that you want. You also can
|
|
specify one of the following special values: <pre>*XLIGHT
|
|
*LIGHT
|
|
*MEDIUM
|
|
*DARK
|
|
*XDARK</pre>
|
|
The default is *MEDIUM if you do not specify a coverage
|
|
value.</div>
|
|
<div class="p">The color specifies which color you want the
|
|
shading to be. If you do not specify a color, then the color prints with the
|
|
default color of the medium. Specify the color in the same manner as you specify
|
|
the previous line colors on the color parameter. For example, to specify coverage
|
|
and color for shading using the RGB color model, specify as follows: <pre>(*SHADE *MEDIUM (*COLOR *RGB rvalue gvalue bvalue))</pre>
|
|
</div>
|
|
<div class="note"><span class="notetitle">Notes:</span> <ol><li>When you specify box shading with no color or with the basic color model,
|
|
IM1 image is used as the fill pattern. This works best on 240/300/600 pel
|
|
printers. It might produce unsatisfactory results on the 4224, 4234, and 64XX
|
|
printers.</li>
|
|
<li>When you specify box shading with an extended color model (RGB, CMYK,
|
|
or CIELAB), IOCA image is used for the fill pattern. IM1 image does not support
|
|
these color models. The IPDS™ printer must support IOCA image for this to print
|
|
properly.</li>
|
|
<li>When you specify box shading with an extended color model, the following
|
|
monochrome IPDS printers
|
|
support gray scaling when you specify highlight color: <ul><li>Infoprint<sup>®</sup> 60</li>
|
|
<li>Infoprint 62</li>
|
|
<li>Infoprint 2000</li>
|
|
<li>Infoprint 3000</li>
|
|
<li>Infoprint 4000</li>
|
|
</ul>
|
|
These printers must be at ucode level 8.3 or later.</li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Use the BOX keyword</h4><p>When the BOX keyword is specified
|
|
on a record format, all fields within the record format must be positioned
|
|
using the POSITION keyword.</p>
|
|
<p>An error message is issued if a constant
|
|
field is specified in a record format where the BOX keyword is also specified.</p>
|
|
<p>An
|
|
error message is issued at application run time if the box extends beyond
|
|
the page boundaries.</p>
|
|
<p>Specify DEVTYPE(*AFPDS) on the CRTPRTF command
|
|
when BOX is specified in the file. If DEVTYPE is changed to anything other
|
|
than *AFPDS, the keyword is ignored and a warning message is issued at print
|
|
time.</p>
|
|
<p>You can specify this keyword multiple times on a record.</p>
|
|
<p>You
|
|
cannot specify BOX with the SPACEA, SPACEB, SKIPA, or SKIPB keywords.</p>
|
|
<p>Option
|
|
indicators are valid for this keyword.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example 1</h4><p>The following example shows how to specify
|
|
the BOX keyword.</p>
|
|
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
|
|
A*
|
|
A R BOX1 BOX(1.2 0.5 5.1 6.3 0.2)
|
|
A*
|
|
A R BOX2 BOX(2 5 5.0 3.33 *WIDE)
|
|
A BOX(0.5 0.1 2.1 2.0 0.09)
|
|
A*
|
|
A R BOX3
|
|
A 01 BOX(0 0 8.5 11.0 0.5)
|
|
A*
|
|
A R BOX4 BOX(1.2 0.5 5.1 6.3 0.2 +
|
|
A (*SHADE 50))
|
|
A R BOX5 BOX(2.5 0.5 5.1 6.3 0.2 +
|
|
A (*COLOR *HIGHLIGHT 3 75)
|
|
A</pre>
|
|
<div class="note"><span class="notetitle">Note:</span> The UOM parameter on the CRTPRTF command determines
|
|
the units of measure for the parameter values.</div>
|
|
<p>BOX1 prints a box
|
|
with one corner located 1.2 units down and 0.5 units across from the location
|
|
specified on the margins specified on the FRONTMGN or BACKMGN parameter on
|
|
the CRTPRTF command. The diagonal corner of this box is located 5.1 units
|
|
down and 6.3 units across from the margins specified on the CRTPRTF command.
|
|
The edges of the box are 0.2 units wide.</p>
|
|
<p>BOX2 prints two boxes. The
|
|
first box starts 2 units down and 5 units across from the margins specified
|
|
on the FRONTMGN or BACKMGN parameter on the CRTPRTF command. The diagonal
|
|
corner of this box is located 5.0 units down and 3.33 units across from the
|
|
margins specified on the CRTPRTF command. The edges of the box are determined
|
|
by the special value *WIDE.</p>
|
|
<p>The second box starts 0.5 units down and
|
|
0.1 units across from the margins specified on the FRONTMGN or BACKMGN parameter
|
|
on the CRTPRTF command. The diagonal corner of this box is located 2.1 units
|
|
down and 2.0 units across from the margins specified on the CRTPRTF command.
|
|
The edges of the box are 0.09 units wide.</p>
|
|
<p>BOX3 prints only if indicator
|
|
01 is on.</p>
|
|
<p>BOX4 specifies shading with 50% coverage and default color
|
|
for shading.</p>
|
|
<p>BOX5 specifies to use highlight color 3 (which is determined
|
|
by printer) with 75% coverage.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example 2</h4><div class="p">The following example shows how to specify
|
|
the BOX keyword. <pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
|
|
*
|
|
R BOX1 BOX(2 3 4 7 0.2)
|
|
*
|
|
R BOX2 BOX(3 5 6 9 0.2)
|
|
*
|
|
*
|
|
</pre>
|
|
</div>
|
|
<p>The following example illustrates the location of the
|
|
boxes using the DDS code in example 2.</p>
|
|
<br /><img src="rzakd504.gif" alt="An illustration of the results produced by Example 2. BOX1 spans columns
3 through 7 and rows 2 through 4. BOX2 spans columns 5 through 9 and rows
3 through 6." /><br /></div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakdmstprkey.htm" title="See the valid keyword entries for defining printer files in this topic.">Keyword entries for printer files (positions 45 through 80)</a></div>
|
|
</div>
|
|
<div class="relconcepts"><strong>Related concepts</strong><br />
|
|
<div><a href="rzakdmstptcolor.htm" title="Use this field-level keyword to specify the color for a field.">COLOR (Color) keyword in printer files</a></div>
|
|
</div>
|
|
<div class="relref"><strong>Related reference</strong><br />
|
|
<div><a href="rzakdmstpositn.htm" title="Use this field-level keyword to define the location of a named field on the page.">POSITION (Position) keyword in printer files</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |