TFORMer SDK - NET
8
|
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. | |
bool | ReuseValues [get, set] |
Gets/Sets a flag indicating whether DataField values should be reused in consecutive Records. |
Abstract base class for JobData.
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:
JobData is always iterated Record by Record, the order of the Records is not changed. All DataFields available in a Record are processed.
It depends on HandleEscapeSequences whether possible escape sequences in the values are translated into their corresponding binary representation. See Escape Sequences for details.
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).
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. For a JobDataRecordSet you have to set the option ignore-undefined-fields
.
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
true
then the value of a DataField will be preserved between records. The last value will be reused in consecutive records until a new value is set.false
(which is the default), then all DataFields are set to "" (empty string) or 0 (depending on the DataFieldType) between records.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.
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.
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.
true
if escape sequences in DataField values are translatedbool ReuseValues [get, set] |
© 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 |