Enumerations Class Reference

Defines the TFORMer enumeration types. More...

List of all members.

Public Types

enum  Aggregation
 Defines the type of Aggregation. More...
enum  DataFieldType
 Defines the type of a DataField. More...
enum  DataFieldUsage
 Describes the usage of a DataField within a FormLayout. More...
enum  DataSourceType
 Defines the type of a DataSource. More...
enum  ELicenseKind
 The license types for the TFORMer Runtime. More...
enum  EPrinterType
 This enumeration specifies the type of output generated by TFORMer Runtime. Choose between direct printing (Win32, Repository, Cups, PostscriptPrinter, TextPrinter, ZPLPrinter) and other supported output formats (PostscriptFile, HtmlFile, PdfFile, TextFile or the various image formats). More...


Detailed Description

Defines the TFORMer enumeration types.

Member Enumeration Documentation

Defines the type of Aggregation.

The type of Aggregation influences the result of a ComputedField's expression. Aggregation defines, if the result of previous records should affect the current result of the ComputedField's expression.
Members
Name Description
None No aggregation function is used.
RunningSum 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.
RunningAvg 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 type.

Defines the type of a DataField.



The type of a DataField influences its use in expressions within a FormLayout. The DataFieldType also influences the conversion method when reading a DataField from a JobData. Currently three different data-types are supported - it is recommended to use the type Text whenever possible.

Members
Name Description
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 exceptions will be raised).
Float A floating point 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 exceptions will be raised).
Invalid Invalid

Describes the usage of a DataField within a FormLayout.

Members
Name Description
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

Defines the type of a DataSource.

Members
Name Description
TFDataFile Internal type, for manual DataSource.
ODBC DataSource is of type ODBC.
CSV DataSource is of type CSV.
XML DataSource is of type XML.
Invalid Invalid type.

The license types for the TFORMer Runtime.

Members
Name Description
Invalid No valid license.
Workstation Workstation license (exactly one installation on a machine identified via the system-id).
Site Site license (up to 250 installations or users (whichever is higher) within one site are allowed).
Developer Developer license (for client-applications only, up to 10000 redistributions per developer license).
Office Office license (up to 100 installations or users (whichever is higher) within one site are allowed).
Workgroup Workgroup license (up to 10 installations or users (whichever is higher) within one site are allowed).
Server Server license (installation on one (web-)server for up to 10000 users).

This enumeration specifies the type of output generated by TFORMer Runtime. Choose between direct printing (Win32, Repository, Cups, PostscriptPrinter, TextPrinter, ZPLPrinter) and other supported output formats (PostscriptFile, HtmlFile, PdfFile, TextFile or the various image formats).


Members
Name Description
Default The default output device type.

The default output device used depends on the type of the form layout to be printed.

Print a 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.
Print a stand-alone FormLayout: A printer of type Win32 will be used on 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 PostScript output (as file). 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.
HtmlFile 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 PDF output (as file).
PostscriptPrinter PostScript output (sent to a 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 Text output (sent to a specific printer).
ImageBmp BMP image output (as file, one file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageGif GIF image output (as file, one file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageJpg JPG image output (as file, one file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImagePcx PCX image output (as file, one file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImagePng PNG image output (as file, one file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageTga TGA image output (as file, one file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageTifSingle TIFF image output (as file, one file per page). The specified filename may contain #-characters as placeholders for the page-number.
ImageTiffMulti TIFF image output (as file, multipage TIFF format).
ZPLPrinter ZPL-II output (sent to a specific ZEBRA printer).
ZPLFile ZPL-II output (as file).
Invalid Invalid


© 2006-2009 All rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Wed Sep 2 16:01:27 2009 for TFORMer Runtime JAVA Developer Reference with doxygen 1.5.8