TECIT.TFORMer Namespace Reference

Classes
class	ComputedField
	Provides access to a ComputedField which is referenced by a DataSource. More...
class	DataField
	Provides access to DataField information. More...
class	DataSource
	Abstract class for a DataSource. More...
class	DataSourceCsv
	Specialized DataSource for CSV data (character separated values). More...
class	DataSourceOdbc
	Specialized DataSource for ODBC data. More...
class	DataSourceParameter
	Provides access to properties of a DataSourceParameter. More...
class	DataSourceXml
	Specialized DataSource for XML data. More...
class	DSFieldMapping
	DSFieldMapping defines the field-mappings between a DataSource and the DataFields used in a Formlayout. More...
class	FormLayout
	Provides access to a FormLayout which is referenced by a Repository or available as stand-alone FormLayout. More...
class	Job
	This is the main class of TFORMer SDK for generating output. More...
class	JobData
	Abstract base class for JobData. More...
class	JobDataCsv
	Provides access to JobDataCsv (a CSV-file that serves as JobData for a Job). More...
class	JobDataDataSource
	Provides access to a user-defined DataSource, which is defined in the FormLayout or a Repository. More...
class	JobDataOdbc
	Provides access to JobDataOdbc (an ODBC connection that serves as JobData for a Job). More...
class	JobDataRecordSet
	Provides access to JobDataRecordSet (a set of in-memory Record objects which serves as JobData for a Job). More...
class	JobDataXml
	Provides access to JobDataXml (a XML file that serves as JobData for a Job). More...
class	JobTrayControl
	Provides access to JobTrayControl information. More...
class	Project
	Provides access to Project information of a Repository or a stand-alone link FormLayout. More...
class	Record
	Provides access to a Record. More...
class	Repository
	Opens or creates a Repository, opens a stand-alone FormLayout. More...
class	TFORMer
	Provides methods to query status information and to license TFORMer SDK. More...
class	TFORMerException
	Exceptions thrown by TFORMer SDK. More...

Enumerations
enum	Aggregation { None = 0 , Running_Sum = 1 , Running_Avg = 2 , Invalid = 3 }
	Defines the type of Aggregation. More...
enum	DataFieldType { Text = 0 , Long = 1 , Float = 2 , Invalid = 3 }
	Defines the type of a DataField. More...
enum	DataFieldUsage {   NotUsed = 0 , Normal = 1 , Calculated = 2 , Parameter = 3 ,   Invalid = 4 }
	Describes the usage of a DataField within a FormLayout. More...
enum	DataFormat { XML }
	Describes the desired format for requested data (eg. More...
enum	DataSourceType {   TFDataFile = 0 , ODBC = 1 , CSV = 2 , XML = 3 ,   Invalid = 4 }
	Defines the type of a DataSource. More...
enum	LicenseKind {   Invalid = 0 , Workstation = 1 , Site = 2 , Developer = 3 ,   Office = 4 , Workgroup = 5 , Server = 6 }
	The license types for the TFORMer SDK. More...
enum	PrinterType {   Default = 0 , Win32 = 1 , Repository = 2 , Cups = 3 ,   PostscriptFile = 4 , HtmlFile = 5 , PdfFile = 6 , PostscriptPrinter = 7 ,   TextPrinter = 8 , TextFile = 9 , ePrinterType_ImageBmp = 10 , ImageBmp = 10 ,   ePrinterType_ImageGif = 11 , ImageGif = 11 , ePrinterType_ImageJpg = 12 , ImageJpg = 12 ,   ePrinterType_ImagePcx = 13 , ImagePcx = 13 , ePrinterType_ImagePng = 14 , ImagePng = 14 ,   ePrinterType_ImageTga = 15 , ImageTga = 15 , ePrinterType_ImageTifSingle = 16 , ImageTifSingle = 16 ,   ePrinterType_ImageTifMultiPage = 17 , ImageTifMultiPage = 17 , ePrinterType_ZPLPrinter = 18 , ZPLPrinter = 18 ,   ePrinterType_ZPLFile = 19 , ZPLFile = 19 , PDFA = 20 , ZUGFeRD = 21 ,   Invalid }
	This enumeration specifies the type of output generated by TFORMer SDK. More...
enum	PrintResultType { None = 0 , Basic , Medium , Full }
	Describes the data that should be stored while generating the output. More...

Enumeration Type Documentation

Aggregation

enum Aggregation

Defines the type of Aggregation.

The type of Aggregation influences the result of a ComputedField. Aggregation defines if the result of previous records should affect the current result of the ComputedField's expression.

To exclude specific Records of the JobData from Aggregation use the ComputedField.Filter.

Enumerator
None	No aggregation function is used.
Running_Sum	Computes the sum of all expression results up to the current Record. For the first Record the running sum is the value itself. For all subsequent Records the values are added.
Running_Avg	Computes the mean value of all expression results up to the current Record. For the first Record the running average is the value itself. For the fifth Record the running average is the average of the first five Records.
Invalid	Invalid Aggregation type.

DataFieldType

enum DataFieldType

Defines the type of a DataField.

See also

DataField

Enumerator
Text	A text (string or character). This is the recommended DataFieldType.
Long	An integer number. When reading a DataField of this type from a JobData it is converted automatically to an integer. In case of conversion errors the result is 0 (no error or exception will be raised).
Float	A floating point number. When reading a DataField of this type from a JobData it is converted automatically to a floating point number. In case of conversion errors the result is 0 (no error or exception will be raised).
Invalid	Invalid, internal use only.

DataFieldUsage

enum DataFieldUsage

Describes the usage of a DataField within a FormLayout.

Enumerator
NotUsed	The DataField is defined within the Project but is not used in the FormLayout.
Normal	A normal DataField. The DataField is in use by the FormLayout, its value is not modified. The DataField is just used as part of expressions or directly in text-, bar-code or picture elements. Therefore the value for this DataField may be provided by an external application or by the user.
Calculated	The DataField is computed automatically. The DataField is in use by the FormLayout and its value is modified. Usually this is done via pre- or post-expressions. Therefore the value for this DataField may not be provided by an external application or by the user.
Parameter	This is a writable system-DataField used by the FormLayout. The value of this system-DataField may be provided by an external application or by the user (e.g. tfDocumentName).
Invalid	Invalid.

DataFormat

enum DataFormat

Describes the desired format for requested data (eg.

XML)

See also

GetPrintResult, GetDetails

Enumerator
XML

DataSourceType

enum DataSourceType

Defines the type of a DataSource.

Enumerator
TFDataFile	Internal type, for a manual DataSource.
ODBC	DataSource is of type ODBC.
CSV	DataSource is of type CSV.
XML	DataSource is of type XML.
Invalid	Invalid type.

LicenseKind

enum LicenseKind

The license types for the TFORMer SDK.

Enumerator
Invalid	Invalid license kind.
Workstation	Workstation license. Supports exactly one installation on a machine which is identified via the system-id.
Site	Site license. Supports a certain number of installations or users within one facility or site (located at a single postal address).
Developer	Developer license. Supports the use of TFORMer SDK in client-applications for a certain number of redistributions.
Office	Office license. Supports a certain number of installations or users within one facility or site (located at a single postal address).
Workgroup	Workgroup license. Supports a certain number of installations or users within one facility or site (located at a single postal address).
Server	Server license. Supports a certain number of total users for a (web-)server based installation.

PrinterType

enum PrinterType

This enumeration specifies the type of output generated by TFORMer SDK.

Choose between direct printing (Win32, Repository, Cups, PostscriptPrinter, TextPrinter, ZPLPrinter) and other supported output formats (PostscriptFile, HtmlFile, PdfFile, TextFile, ZPL-file or the various image formats).

See also

Output Format Prefixes, OutputName, PrinterType, PrinterName

Note

Thread-safety: A single instance of this class must not be used by different threads.

Enumerator
Default	The default output device type. The output device which will be used depends on the type of the FormLayout to be printed. Repository-based FormLayout: A printer of type Repository will be used. Without the specification of a PrinterName the default printer within this Repository (named Default) is used. Stand-alone FormLayout: A printer of type Win32 will be used on Microsoft Windows. For Linux and UNIX a printer of type Cups will be used.
Win32	Direct printing to a Windows printer via GDI-calls (Microsoft Windows only).
Repository	The printer as defined in the Repository or stand-alone FormLayout. In the later case only the printer Default is used (which maps to the default printer of the current user). To use other printers set the PrinterType to Win32.
Cups	A CUPS printer (Linux and UNIX only).
PostscriptFile	This printer type generates PostScript output as file. The PostScript header and footer used for each page may be customized. See Footer.ps and Header.ps in the TFORMer installation directory for details.
HtmlFile	This printer type generates HTML output as file. Some aspects of the index page and the footer appended to each generated HTML page may be customized. See Footer.html and Template.html in the TFORMer installation directory for details.
PdfFile	This printer type generates PDF output as file.
PostscriptPrinter	This printer type sends PostScript output directly to the specific printer. The PostScript header and footer used for each generated page may be customized. See Footer.ps and Header.ps in the TFORMer installation directory for details.
TextPrinter	This printer type sends ASCII output directly to the specific printer.
TextFile	This printer type generates ASCII output as file.
ePrinterType_ImageBmp	This printer type generates BMP image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageBmp
ePrinterType_ImageGif	This printer type generates GIF image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageGif
ePrinterType_ImageJpg	This printer type generates JPG image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageJpg
ePrinterType_ImagePcx	This printer type generates PCX image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImagePcx
ePrinterType_ImagePng	This printer type generates PNG image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImagePng
ePrinterType_ImageTga	This printer type generates TGA image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageTga
ePrinterType_ImageTifSingle	This printer type generates TIFF image files (one image file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageTifSingle
ePrinterType_ImageTifMultiPage	This printer type generates multi-page TIFF image files (one image contains all output pages).
ImageTifMultiPage
ePrinterType_ZPLPrinter	This printer type sends ZPL-II (ZEBRA Printer Language) output directly to the specific printer.
ZPLPrinter
ePrinterType_ZPLFile	This printer type generates ZPL-II (ZEBRA Printer Language) output as file.
ZPLFile
PDFA	This printer type generates PDF/A output as file.
ZUGFeRD	This printer type generates ZUGFeRD PDF/A-3 output as file and attaches the given ZUGFeRD-invoice.xml to it (see http://www.zugferd.de).
Invalid	Invalid or unspecified printer type. Do not use this value (internal use only).

PrintResultType

enum PrintResultType

Describes the data that should be stored while generating the output.

After the output has been generated the data can be retrieved by a call to GetPrintResult.

See also

PrintResultType, GetPrintResult

Enumerator
None	No data should be generated.
Basic	Only basic information should be generated.
Medium	Additional data will be stored.
Full	All information possible will be stored and is available after output generation.