TFORMer SDK - NET 8
Properties | List of all members
JobData Class Reference

Abstract base class for JobData. More...

Properties

bool HandleEscapeSequences [get, set]
 Gets/Sets a flag indicating whether escape sequences in DataField values like \n or \x40 should be translated by TFORMer SDK. More...
 
bool ReuseValues [get, set]
 Gets/Sets a flag indicating whether DataField values should be reused in consecutive Records. More...
 

Detailed Description

Abstract base class for JobData.

JobData

Overview

TFORMer SDK retrieves data used for printing a Job with the help of JobData.

JobData is used to provide values for the DataFields used in a FormLayout.

Different types of JobData classes are supported:

Data Processing

JobData is always iterated Record by Record, the order of the Records is not changed. All DataFields available in a Record are processed.

Note
TFORMer requires at least one Record to produce output.

Escape Sequences

It depends on HandleEscapeSequences whether possible escape sequences in the values are translated into their corresponding binary representation. See Escape Sequences for details.

Record Copies

Each Record of a DataSource is usually considered exactly once for generating output. Use DataSource.CopyColumnName to instruct TFORMer SDK to use a specific field of the DataSource which contains the copy counter. This feature is helpful whenever a single Record of a DataSource should be printed multiple times (e.g. if a certain number of identical labels should be printed).

Unknown DataFields in JobData

If the JobData provides more DataFields than defined (either in the stand-alone FormLayout or in the Project of the Repository), these additional fields will be ignored.

Missing DataFields in JobData

If a DataField, which is used in the FormLayout, is not present in the JobData its value depends on JobData.ReuseValues. if JobData.ReuseValues is set to

Note
DataFields which are computed with post- or pre-evaluations within a FormLayout will not be cleared (see DataFieldUsage).

Missing or Empty JobData

If no (or an empty) JobData was specified then TFORMer SDK uses the default DataSource for printing the Job. The default data is stored in an extra file located in the same directory as the FormLayout itself and is named FormlayoutName.xml. It contains the DataField values used during the last TFORMer Designer session.

If no file with default data exists TFORMer SDK produces no output.

Identifying the Required DataFields

In order to identify all DataFields in a Project or in a FormLayout use the functions Project.FirstDataField and DataField.Next. If you want to know, whether a returned DataField is actually used in the FormLayout use the function FormLayout.GetDataFieldUsage.

More Information

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

Property Documentation

◆ HandleEscapeSequences

bool HandleEscapeSequences
getset

Gets/Sets a flag indicating whether escape sequences in DataField values like \n or \x40 should be translated by TFORMer SDK.

Returns
true if escape sequences in DataField values are translated
See also
JobData, Escape Sequences

◆ ReuseValues

bool ReuseValues
getset

Gets/Sets a flag indicating whether DataField values should be reused in consecutive Records.

Returns
false if DataField-values should be cleared between Records
See also
JobData, DataField

© 2006-2023 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Thu Dec 28 2023 18:45:19 for TFORMer SDK - NET with doxygen 1.9.4