Select your printer model
PrinterControl XML
These XMLs are used to control print operations of a printer. <epos-print> is included in the child element printdata of the <type> element print, while <response> is included in the child element resultdata of the <type> element onxmlresult.
<epos-print> and <response> can be used with the following <type> elements.
Device |
<type> element |
Child element |
XML document |
---|---|---|---|
printdata |
|||
resultdata |
|||
printdata |
|||
resultdata |
|||
printdata |
|||
Creating print document
These XMLs request the printer to execute a print function specified with <epos-print> and acquires the execution result with <response>.
XML document |
Child element |
Function |
---|---|---|
Prints text. |
||
Paper feed |
||
Prints a raster image. |
||
Prints the NV logo. |
||
Prints a barcode. |
||
Prints a 2D symbol. |
||
Prints a horizontal ruled line. |
||
Starts printing a vertical ruled line. |
||
Ends printing a vertical ruled line. |
||
Switches to the page mode |
||
Defines the print area in the page mode. |
||
Specifies the print direction in the page mode. |
||
Specifies the print position in the page mode. |
||
Draws a line in the page mode. |
||
Draws a shape in the page mode. |
||
Cuts the sheet. |
||
Kicks the drawer. |
||
Sounds the buzzer. |
||
Inserts a command. |
||
Sets the page layout. |
||
Recovers from a recoverable error. |
||
Resets the printer. |
||
Starts the batch normal print mode. |
||
Ends the batch normal print mode. |
||
Starts the batch rotate print mode. |
||
Ends the batch rotate print mode. |
||
Acquires the execution result. |
The print mode includes the standard mode, page mode, batch normal print mode, and the batch rotate print mode.
- Standard mode
-
Prints data line by line. Line spacing is automatically adjusted according to character size, image size, and barcode height. Suitable for printing receipts whose print length varies by print content.
- Page mode
-
Prints page by page. Prints characters, images, and/or barcodes on a single page that is defined as a print area.
To print in the page mode, switch to the page mode using <page>. - Batch normal print mode
-
This is a print mode in which the range of the print data (such as characters, images, barcodes, etc.) is set, and the print data in the set range is compiled, and then printed.
Unlike the standard mode, printing starts after the entire print data has been received.
When performing the processing in the batch normal print mode, start the batch normal print processing with <batch-begin>, and end the batch normal print processing with <batch-end>.
- Batch rotate print mode
-
This is a print mode in which the range of the print data (such as characters, images, barcodes, etc.) is set, the print data in the set range is compiled, inverted, and then printed.
When performing the processing in the batch rotate print mode, start the batch rotate print processing with <rotate-begin>, and end the batch rotate print processing with <rotate-end>.
The child elements that can be used in each mode are described in the table below.
XML document |
Child element |
Standard mode |
Page mode |
Batch normal print mode |
Batch rotate print mode |
---|---|---|---|---|---|
✔ |
✔ |
✔ |
✔ |
||
✔ |
✔ |
✔ |
✔ |
||
✔ |
✔ |
✔ |
✔ |
||
✔ |
✔ |
✔ |
✔ |
||
✔ |
✔ |
✔ |
✔ |
||
✔ |
✔ |
✔ |
✔ |
||
✔ |
- |
✔ |
✔ |
||
✔ |
- |
✔ |
✔ |
||
✔ |
- |
✔ |
✔ |
||
✔ |
- |
- |
- |
||
- |
✔ |
- |
- |
||
- |
✔ |
- |
- |
||
- |
✔ |
- |
- |
||
- |
✔ |
- |
- |
||
- |
✔ |
- |
- |
||
✔ |
- |
- |
- |
||
✔ |
- |
- |
- |
||
✔ |
- |
- |
- |
||
✔ |
✔ |
✔ |
✔ |
||
✔ |
- |
✔ |
✔ |
||
✔ |
- |
- |
- |
||
✔ |
- |
- |
- |
||
✔ |
- |
- |
- |
||
✔ |
- |
✔ |
- |
||
✔ |
- |
- |
- |
||
✔ |
- |
- |
✔ |
||
✔ |
✔ |
✔ |
✔ |
List of support per print method
Child element |
Print method |
||||
---|---|---|---|---|---|
Receipt |
Slip |
Endorsement |
Endorsement (40cpl) |
Validation |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
- |
- |
- |
- |
|
✔ |
- |
- |
- |
- |
|
✔ |
- |
- |
- |
- |
|
✔ |
- |
- |
- |
- |
|
✔ |
- |
- |
- |
- |
|
✔ |
- |
- |
- |
- |
|
✔ |
- |
- |
- |
- |
|
✔ |
✔ |
- |
- |
✔ |
|
✔ |
✔ |
- |
- |
✔ |
|
✔ |
✔ |
- |
- |
✔ |
|
✔ |
✔ |
- |
- |
✔ |
|
✔ |
✔ |
- |
- |
- |
|
✔ |
✔ |
- |
- |
- |
|
✔ |
- |
- |
- |
- |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
- |
- |
- |
- |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
- |
- |
- |
- |
|
✔ |
✔ |
✔ |
✔ |
✔ |
|
✔ |
✔ |
✔ |
✔ |
✔ |
List of child element default values
The default values of the child elements are listed below.
These values are effective before executing a child element defined on the printer device.
Child element |
Attribute |
Default value |
---|---|---|
lang |
“en” |
|
font |
“font_a” |
|
smooth |
“false” / “0” |
|
dw |
“false” / “0” |
|
dh |
“false” / “0” |
|
width |
“1” |
|
height |
“1” |
|
reverse |
“false” / “0” |
|
ul |
“false” / “0” |
|
em |
“false” / “0” |
|
color |
“color_1” |
|
x |
“0” |
|
y |
“21” |
|
align |
“left” |
|
rotate |
“false” / “0” |
|
linespc |
Depends on the printer model. For details, refer to Printer-specific Support Information. |
|
linespc |
||
color |
“color_1” |
|
align |
“left” |
|
mode |
“mono” |
|
align |
“left” |
|
hri |
“none” |
|
font |
“font_a” |
|
width |
“3” |
|
height |
“162” |
|
align |
“left” |
|
rotate |
“false” / “0” |
|
level |
Depends on the 2D symbol type. Refer to <symbol> for details. |
|
width |
||
hight |
||
size |
||
align |
“left” |
|
rotate |
“false” / “0” |
|
x |
“0” |
|
y |
“0” |
|
width |
Depends on the printer model. For details, refer to Printer-specific Support Information. |
|
height |
||
dir |
“left_to_right” |
|
x |
“0” |
|
y |
“21” |
Quick Access
- [Name]
- [Format]
- [Range]
- [Description]
- [Notes]
- Introduction
- help
- Message
- CommunicationBox Messages
- Device Messages
- DeviceHubTerminal
- BarcodeScanner
- Printer
- <type>print</type>
- <type>onxmlresult</type>
- <epos-print>
- <response>
- <text>
- <feed>
- <image>
- <logo>
- <barcode>
- <symbol>
- <hline>
- <vline-begin>
- <vline-end>
- <page>
- <area>
- <direction>
- <position>
- <line>
- <rectangle>
- <cut>
- <pulse>
- <sound>
- <command>
- <layout>
- <recovery>
- <reset>
- <batch-begin>
- <batch-end>
- <rotate-begin>
- <rotate-end>
- HybridPrinter
- <type>lock</type>
- <type>unlock</type>
- <type>print</type>
- <type>onxmlresult</type>
- <type>slipwaitinsertion</type>
- <type>slipprint2</type>
- <type>slipcancel</type>
- <type>endorsewaitinsertion</type>
- <type>endorseprint2</type>
- <type>endorsecancel</type>
- <type>validationwaitinsertion</type>
- <type>validationprint2</type>
- <type>validationcancel</type>
- <type>micrread</type>
- <type>micrcleaning</type>
- <type>micrcancel</type>
- <type>eject</type>
- <type>onreceive</type>
- CustomerDisplay
- Keyboard
- POSKeyboard
- MSR
- SerialDevice
- Storage
- OtherPeripheral
- Appendix