Table of advanced print options supported by PrintOptions.

Overview

PrintOptions 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

Media and Layout

Option	Output Type	Description
`media`	Win32 Printers	The value has to match an existing printer form name
`media`	Other Printers	The value has to match a predefined media name (`A4`) or has to be specified in the format Custom.WidthxHeight e.g. `Custom.220mmX10cm`
`mediasource`	Win32 Printers	Either the name (`mediasource="Tray 2"`) or the id (`mediasource=260`) of an existing tray
`mediasource`	Other Printers	No effect
`mediatype`	Win32 Printers	Either the name (`mediatype="Glossy"`) or the id (`mediatype=3`) of an existing media type
`mediatype`	Other Printers	No effect
`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).
`resolution`	Image, HTML and ZPL Printers	Value in dpi (dots per inch)
`resolution`	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
`duplex`	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
`collate`	Other Printers	No effect
`copies`	All Printers	The value specifies the number of copies
`simulatecopies`	Win32 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)
`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}`

Error Handling

Option	Output Type	Description
`barcode-error`	All	`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`	All	`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`	All	`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`	All	`abort`, abort printing if an error occurs `ignore`, ignore the error and continue printing `print`, print the error information instead of the component
`ignore-undefined-fields`	All	Specifies if undefined fields are ignored by Job.Print when using JobDataRecordSet. `Yes`, `True` or `1` to ignore undefined fields `No`, `False` or `0` (Default) to return an error if field name is unknown

Fonts / Formatting

Option	Output Type	Description
`font-linking`	All	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`	All	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
`soft-hyphens`	All	Specifies the optional soft-hyphen characters (comma separated).
`hyphen`	All	Specifies the hyphen character which should be printed when a word-break is triggered by a soft-hyphen.
`locale`	All	Specifies the locale for printing.

Windows Printers (GDI)

Option	Output Type	Description
`tbarcode-drawing-mode`	Only 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-mode`	Only 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

Zebra Printers

Option	Output Type	Description
`header`	ZPL Printers	Commands sent to printer at job beginning (Sample: `header="^XA^MMC^XZ"` to set print mode to cutter).
`header`	Other Printers	No effect
`footer`	ZPL Printers	Commands sent to printer at job ending.
`footer`	Other Printers	No effect
`zpl-compression`	ZPL Printers	`none`, `rle`, `png` or `zip` specifies the image compression for graphics embedded in ZPL.
`zpl-compression`	Other Printers	No effect
`zpl-lt`	ZPL 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.
`zpl-lt`	Other Printers	No effect
`zpl-ls`	ZPL 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.
`zpl-ls`	Other Printers	No effect
`zpl-comments`	ZPL Printers	Specifies if zpl comments (including document name, resolution etc.) should be added to the generated zpl data. Default is no.
`zpl-comments`	Other Printers	No effect
`zpl-image-crop`	ZPL Printers	Specifies if the generated image that is embedded in the zpl data should be cropped or not (default is on).
`zpl-image-crop`	Other Printers	No effect

Advanced

Option	Output Type	Description
`cupsoptions`	PostScript CUPS-Printer	Specifies additional cups options that should be passed to the cups printer.
`cupsoptions`	Other Printers	This option is ignored.
`eval-file-name-per-page`	Only Image, SVG and SVGZ Printers	Specifies whether the file name for image exports should be re-evaluated for each page based on the document name. Can be used to specify a file name via an expression or data field. By default, the file name is only evaluated once at the start of each job and the pages (image files) are created by appending an index number to the evaluated document name. `Yes`, `True` or `1` to evaluate the file name per page `No`, `False` or `0` (Default) to evaluate the file name only once
`print-to-file`	Win32 Printers	Redirects Windows printer driver output to a file. If true or no value is specified, Windows opens a Save As dialog that allows the user to select the location and filename for the output file. Note that the backslash character \ must be replaced with \ to "escape" it. Example: print-to-file="C:\\Temp\\TestOutput.prn"
`print-to-file`	Other Printers	No effect
`SavePersistentSerials`	All	`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.
`zugferd-xml`	Only 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 / Meta-Information

Option	Output Type	Description
`document-creator`	PDF Printer PostScript File/Printer HTML File	Specifies a custom document creator (default: tfProductName - tfProductVersion).
`document-creator`	Other Printers	No effect
`document-producer`	PDF Printer HTML File	Specifies a custom document producer (default: TEC-IT Datenverarbeitung GmbH (www.tec-it.com)).
`document-producer`	Other Printers	No effect
`document-title`	PDF Printer PostScript File/Printer HTML File	Specifies the document's title.
`document-title`	Other Printers	No effect
`document-author`	PDF Printer HTML File	Name of the person who created the document.
`document-author`	Other Printers	No effect
`document-subject`	PDF Printer HTML File	Specifies the subject of the document.
`document-subject`	Other Printers	No effect
`document-keywords`	PDF Printer HTML File	Specifies keywords associated with the document.
`document-keywords`	Other Printers	No effect

PDF Security Options

Option	Description
`pdf-user-password`	Specifies the password which is required for opening a document.
`pdf-owner-password`	Specifies the password which is required to change user permissions.
`pdf-printing-permission`	Specifies the printing permission. `none`, disallow printing `low-resolution`, allow only low-resolution printing `high-resolution`, allow full printing
`pdf-modify-permission`	Specifies the modify permission. `none`, allow no modifications `assembly`, allow document assembly only `annotate`, assembly permissions plus commenting `all`, allow full document modification
`pdf-allow-copy-content`	`Yes`, `True` or `1` allow copying of any content. `No`, `False` or `0` disallow copying of any content.
`pdf-allow-screen-reader-text-access`	`Yes`, `True` or `1` allow screen reader to access content. `No`, `False` or `0` disallow screen reader to access content.
`pdf-encrypt-content`	`all` encrypt all content `exclude-meta-data` prevent encryption of metadata

© 2006-2024 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Wed Aug 7 2024 17:29:42 for TFORMer SDK - NET with doxygen 1.7.6.1