Begin Overlay - Printronix S828 Programmer's Manual

Programmer Manual
Begin Overlay (BO)
Length D6DF Flag
The Begin Overlay command causes the printer to leave the home state and enter the overlay state. This
command defines data that the printer saves for later use within an overlay. The printer later merges the
stored overlay with ordinary printed pages by using the Include Overlay command or the Load Copy
Control command. The current Load Page Description, Load Font Equivalence, and Load Equivalence
records, if any, become part of the definition of the overlay. The definition of the overlay terminates by an
End Page command. The overlay itself is between the Begin Overlay and the End Page commands.
The DATA field is one byte and it specifies the overlay ID. Valid values for this byte are decimal 1 through
254 (X'1' through X'FE''). If this value specifies an overlay identifier already loaded in the printer, an
exception occurs.
Note: Because overlays use more than the normal amount of printer storage, use overlays only when
data needs to be kept.
Delete Overlay (DO)
Length D6EF Flag
The Delete Overlay command deletes (clears) either a single overlay or all overlays from the printer
memory.
The DATA field is one byte in length and can be any value between 0 and 254 (X'00' to X'FE'). This value
is the overlay identifier, and it specifies the overlay to be deleted. If this value is zero, all overlays are
deleted.
Include Overlay (IO)
Length D67D Flag
The Include Overlay command causes a previously stored overlay to merge onto the current page at the
specified presentation position. Following the inclusion and processing of an overlay, the current print
position remains where it was prior to the overlay processing. The printer restores all page description
values, font and suppression equivalences, and text control values to the values that existed for each at
the time the overlay was processed.
The DATA field is 10 bytes in length, and contains the following:
Decimal Hex
0-1 0-1
2 00
3-5 3-5
6 6
Chapter 5 IPDS Programming Information
Correlation ID (Optional)
Correlation ID (Optional)
Correlation ID (Optional)
Content
0001 - 00FE
000000 -
007FFF
FF8000 -
FFFFFE
FFFFFF
00
DATA
DATA
DATA
Description
Overlay ID
Reserved
X Coordinate
Positive Offset Value Relative to the Logical Page
Negative Offset Value Relative to the Logical Page
Use the Current Inline Text Position
Reserved
210
PTX‐S828
260071‐001A