BarTender XML Script Format |
BarTender XML (BTXML) script uses an XML style format to process print jobs. Users create BTXML commands as a script or as a file and send it to BarTender using the command line or by one of the automation methods described in the Overview. BarTender processes the code and completes the task that the code defines.
All BTXML commands sent to BarTender must have the following format:
<?xml version="1.0" encoding="utf-8"?>
<XMLScript Version="2.0">
<Command>
...
</Command>
</XMLScript>
The supported attributes for the <XMLScript> tag include:
Attribute |
Required/Optional |
Description |
---|---|---|
Version |
Required |
XML script version. |
Name |
Optional |
Name to identify the XML script request. |
ID |
Optional |
Unique identification number to identify the XML script request. |
The <XMLScript> Message Format must contain a command. The supported commands include:
FormatSetup: Allows a document to be loaded and configured before defining other commands.
Print: Prints a BarTender document.
ExportPrintPreviewToImage: Creates a print preview image of the document and exports the image to an image file.
Each time a command is passed to BarTender, an XML response is generated and returned to the user. The response can contain various levels of information including print job, printer, and template information depending upon how the response attributes are set in the Print command. Refer to Response for a complete description of its content and syntax.
BTXML Script version 1.0 (BarTender 8.0 and later versions)
Related Topics