TFORMer SDK - DLL/Library  8
Print Options

Table of advanced print options supported by TFormer_SetPrintOptions.

Overview

TFormer_SetPrintOptions allows to specify additional printing options. The options are specified as a string containing named values in the form [OptionName]=[value]. Multiple options are delimited by white-spaces. Values containing spaces need to be enclosed by " or ' ([OptionName]='value 1'). If values contain ", ' or \ characters, they need to be escaped with \, like \', \" and \\ ([OptionName]='\", \' and \\ need to be escaped').

List of Supported Options

Option Output TypeDescription
media Win32 Printers The value has to match an existing printer form name
Other Printers The value has to match a predefined media name or has to be specified in the format Custom.WidhtxHeight e.g. Custom.220mmX10cm
mediasource Win32 Printers Either the name (mediasource="Tray 2") or the id (mediasource=260) of an existing tray
Other Printers No effect
resolution Image, HTML and ZPL Printers Value in dpi (dots per inch)
Other Printers No effect
orientation All Printers Landscape
Portrait
duplex Win32 printers
PostScript File/Printer
Vertical, Yes, True or 1 for vertical duplex printing
Horizontal for horizontal duplex printing
Simplex, None, No, False or 0 for no duplex printing
Other Printers No effect
collate Win32 printers
PostScript File/Printer
Option has no effect if SimulateCopies is true otherwise
Yes, True or 1 for collating output
No, False or 0 for not collating output
Other Printers No effect
copies All Printers The value specifies the number of copies
simulatecopiesWin32 printers
PostScript File/Printer
Yes, True or 1 specifies that TFORMer will simulate copies
No, False or 0 specifies that the printer driver should handle copies
ZPL Printers Yes, True or 1 specifies that TFORMer will simulate copies (collated)
No, False or 0 specifies that the printer driver should handle copies (not collated)
Other Printers This option is ignored, copies are always simulated (collated)
barcode-error abort, abort printing if an error occurs
ignore, ignore the error and continue printing
print, print the error information instead of the component
image-error abort, abort printing if an error occurs
ignore, ignore the error and continue printing
print, print the error information instead of the component
expression-error abort, abort printing if an error occurs
ignore, ignore the error and continue printing
print, print the error information instead of the component
unicode-font-error abort, abort printing if an error occurs
ignore, ignore the error and continue printing
print, print the error information instead of the component
soft-hyphens Specifies the optional soft-hyphen characters (comma separated).
hyphen Specifies the hyphen character which should be printed when a word-break is triggered by a soft-hyphen.
offsetX Specifies the horizontal offset of the top left corner (shift right: offsetX=3.2mm). Default unit is mm, if required you can specify other units like in, cm, m, mil, etc. (see TFORMer Designer).
offsetY Specifies the vertical offset of the top left corner (shift down: offsetY=3.2mm). Default unit is mm, if required you can specify other units like in, cm, m, mil, etc. (see TFORMer Designer).
rotation Specifies the additional counter-clockwise output rotation in steps of 90 degrees (will be added to the rotation of the form).
SavePersistentSerials

Yes, True or 1 specifies that TFORMer will save the values of persistent serials. No, False or 0 specifies that persistent serials will not be saved. This option is usually used for implementing preview functionality.

header ZPL Printers Commands sent to printer at job beginning (Sample: header="^XA^MMC^XZ" to set print mode to cutter).
Other Printers

No effect

footer ZPL Printers Commands sent to printer at job ending.
Other Printers

No effect

zpl-compressionZPL Printers none, rle or png specifies the image compression for graphics embedded in ZPL.
Other Printers

No effect

zpl-ltZPL Printers Specifies the metric value for the ZPL LT (label top) command (zpl-lt='3.2mm', zpl-lt='-4').
Default unit is mm, if required you can specify other units like in, cm, m, mil, etc.
If empty (zpl-lt=''), the LT command will not be included in the generated ZPL output.
Other Printers

No effect

zpl-lsZPL Printers Specifies the metric value for the ZPL LS command (label shift) (zpl-ls='3.2mm').
Default unit is mm, if required you can specify other units like in, cm, m, mil, etc.
If empty (zpl-ls=''), the LS command will not be included in the generated ZPL output.
Other Printers

No effect

ignore-undefined-fields

Specifies if undefined fields are ignored by TFormer_SetVarValue.
Yes, True or 1 to ignore undefined fields
No, False or 0 (Default) to return an error if field name is unknown

tbarcode-drawing-modeOnly Win32 Printers

Specifies the method for printing barcodes on Win32 printers.
default, default method
compatible, use the GDI rectangle functions to draw bars. May result in sub-optimal output quality, but is compatible to all printers.
quality, best quality. Supported by most printers.
dual, combination of compatible and quality

transparent-image-drawing-modeOnly Win32 Printers

Specifies the drawing method for printing transparent images on Win32 printers. This is an advanced option to avoid printer-driver specific problems.
default, default method
auto, tries to determine best method
TransparentBlt, use TransparentBlt mthod
MaskBlt, use MaskBlt
BitBlt, use combination of BitBlts, needs access to device pixels
Opaque, ignore transparency and print image opaque

font-linking

Specifies if font linking is allowed. Default yes. If a character is not supported by given font, tformer tries to find a font that will provide the needed character glyph.
Yes, True or 1 (Default) for font linking
No, False or 0 do not use font linking

font-substitution

Specifies if font substitution is allowed. Default yes.
Yes, True or 1 (Default) tformer tries to find fallback font for unknown fonts
No, False or 0 (Default) do not use font substitution

layout

Specifies an option string to modify layout settings when printing.
Available options are:
rows, row-height, row-spacing,
columns, column-width, column-spacing,
margins
All options but margins support the value auto.
Margins can be specified by using a container or a simple value.
E.g. margins=2cm or margins={left=1cm right=2cm top=1cm botttom=2cm}

zugferd-xmlOnly ZUGFeRD PDF Printer

Specifies the required ZUGFeRD-invoce.xml file that should be attached to ZUGFeRD PDF/A-3 output.
The file name can be specified either as value or as option string. When specified as an option string, additional options are available for more detailed control over how the file is embedded.
Available options are:
file or filename, embedded-filename, compress,
description
If no or empty embedded-filename is given, the default name given in the specifications for ZUGFerD based on the content of the invoice file is used ( "ZUGFeRD-invoice.xml", "factur-x.xml" or "xrechnung.xml" ).
If description is not specified, the default description given in the specifications for ZUGFerD is used.
The default value for the option compress is yes.
E.g. zugferd-xml="c:/temp/Invoice.xml" or zugferd-xml={file="c:/temp/Invoice.xml" embedded-filename="InvoiceNameInPdf.xml"}

document-creatorPDF Printer
PostScript File/Printer
HTML File
Specifies a custom document creator (default: tfProductName - tfProductVersion).
Other Printers

No effect

document-producerPDF Printer
HTML File
Specifies a custom document producer (default: TEC-IT Datenverarbeitung GmbH (www.tec-it.com)).
Other Printers

No effect

document-titlePDF Printer
PostScript File/Printer
HTML File
Specifies the document's title.
Other Printers

No effect

document-authorPDF Printer
HTML File
Name of the person who created the document.
Other Printers

No effect

document-subjectPDF Printer
HTML File
Specifies the subject of the document.
Other Printers

No effect

document-keywordsPDF Printer
HTML File
Specifies keywords associated with the document.
Other Printers

No effect

cupsoptions PostScript Cups-Printer Specifies additional cups options that should be passed to the cups printer.
Other Printers

This option is ignored.

locale

Specifies the locale for printing.


© 2006-2021 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Wed Nov 17 2021 12:13:03 for TFORMer SDK - DLL/Library with doxygen 1.7.6.1