Output Format Prefixes

Output formats supported by TFORMer.

Overview

The term printing is used whenever TFORMer generates output. By default the generated output is sent directly to a printer (hence the name), but the output can also be stored in files or generated as an in-memory stream.

TFORMer supports two methods for selecting the output format:

• If called with a prefix for the output format (see table below), TFormer_SetPrinterName sets type and destination of the output. If the target name is specified without any prefix, TFORMer assumes that the output should be printed directly onto this printer.
• As an alternative to TFormer_SetPrinterName you may use both TFormer_SetPrinterType and TFormer_SetOutputName.

Example

To generate output as a PDF document named out.pdf in some temp directory, do the following:

  // Select PDF output to /temp/out.pdf with the PDFFILE prefix
  eCode = TFormer_SetPrinterName  (hTForm, "PDFFILE:/temp/out.pdf", NULL);              

which is equivalent to:

  // Select PDF output to /temp/out.pdf with setPrinterType and setOutputName
  eCode = TFormer_SetPrinterType  (hTForm, ePrinterType_PDFFile);
  eCode = TFormer_SetOutputName   (hTForm, "/temp/out.pdf");

By using suitable prefixes (see table below) the output format can be adjusted.

Output Format Prefixes

Output Devices and Formats

Prefix	Example	Description
No Prefix	HP4050PS	Direct printing to the printer specified. This method is only available under Microsoft Windows and uses GDI methods. Supply a printer name as defined by Windows (\\server\printer, printer). On Windows platforms the parameter pDevMode may be used to modify default GDI printer settings. All valid fields passed via pDevMode are merged with the default settings of the selected printer. For more information check out the Win32 SDK documentation.
PDFFile:	PDFFile:C:\Temp\out.pdf	PDF-output is stored in C:\temp\out.pdf
PDF:	PDF:C:\Temp\out.pdf	PDF-output is stored in C:\temp\out.pdf
PDFA:	PDFA:C:\Temp\out.pdf	PDF/A-output is stored in C:\temp\out.pdf
HTML:	HTML:C:\Temp\out.html	HTML-output stored in C:\temp\out.html and automatically named subfolders
PS:	PS:C:\Temp\out.ps	PostScript-output is stored in C:\temp\out.ps
PSPRINTER:	PSPRINTER:HP4050PS	Direct printing to the printer specified. Because the output format is already PostScript a generic ASCII printer driver must be used.
TXT:	TXT:C:\temp\out.txt	Plain text output is stored in C:\temp\out.txt
TXTPRINTER:	TXTPRINTER:ZEBRA4M	Direct printing to the printer specified. Because the output format is plain text which may contain printer control sequences a generic ASCII printer driver must be used.
REPO:	REPO:PrinterName	Direct printing to the printer specified in the Repository. This method is only available under Microsoft Windows and uses GDI methods.
IMGBMP:	IMGBMP:C:\temp\out.bmp	The BMP image file named out.bmp is stored in C:\temp. If the output consists of multiple pages, multiple output files are generated. In this case the page number is appended to the filename (e.g. out_001.bmp). As an alternative you can use the # character as placeholder for the page number: e.g. out###.bmp
IMGGIF:	IMGGIF:C:\temp\out.gif	The GIF image file named out.gif is stored in C:\temp. If the output consists of multiple pages, multiple output files are generated. In this case the page number is appended to the filename (e.g. out_001.gif). As an alternative you can use the # character as placeholder for the page number: e.g. out###.gif
IMGJPG:	IMGJPG:C:\temp\out.jpg	The JPG image file named out.jpg is stored in C:\temp. If the output consists of multiple pages, multiple output files are generated. In this case the page number is appended to the filename (e.g. out_001.jpg). As an alternative you can use the # character as placeholder for the page number: e.g. out###.jpg
IMGPCX:	IMGPCX:C:\temp\out.pcx	The PCX image file named out.pcx is stored in C:\temp. If the output consists of multiple pages, multiple output files are generated. In this case the page number is appended to the filename (e.g. out_001.pcx). As an alternative you can use the # character as placeholder for the page number: e.g. out###.pcx
IMGPNG:	IMGPNG:C:\temp\out.png	The PNG image file named out.png is stored in C:\temp. If the output consists of multiple pages, multiple output files are generated. In this case the page number is appended to the filename (e.g. out_001.png). As an alternative you can use the # character as placeholder for the page number: e.g. out###.png
IMGTGA:	IMGTGA:C:\temp\out.tga	The TGA image file named out.tga is stored in C:\temp. If the output consists of multiple pages, multiple output files are generated. In this case the page number is appended to the filename (e.g. out_001.tga). As an alternative you can use the # character as placeholder for the page number: e.g. out###.tga
IMGTIF:	IMGTIF:C:\temp\out.tif	The TIF image file named out.tif is stored in C:\temp. If the output consists of multiple pages, multiple output files are generated. In this case the page number is appended to the filename (e.g. out_001.tif). As an alternative you can use the # character as placeholder for the page number: e.g. out###.tif
IMGMULTITIF:	IMGMULTITIF:C:\temp\out.tif	The TIF image file named out.tif is stored in C:\temp. All pages are stored in a single output file.
ZPL:	ZPL:C:\temp\out.zpl	ZPL-II output (suitable for ZEBRA printers) is stored in C:\temp\out.zpl.
ZPLPRINTER:	ZPLPRINTER:ZEBRA4M	Direct printing in ZPL-II format to the operating system printer named ZEBRA4M. Because the output format is already ZPL-II a generic ASCII printer driver must be used.
ZUGFERD:	ZUGFERD:C:\Temp\out.pdf	ZUGFeRD-output is stored in C:\temp\out.pdf. Requires an additional ZUGFeRD-invoice.xml provided either using the SDK-option zugferd-xml (Print Options) or using the report property ZUGFeRD-XML.
SVG:	SVG:C:\Temp\out.svg	SVG-output is stored in C:\temp\out.svg.
SVGZ:	SVG:C:\Temp\out.svgz	SVGZ-output is stored in C:\temp\out.svgz.