Provides access to JobDataRecordSet (a set of in-memory Record objects which serves as JobData for a Job). 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...

List< Record >	Records `[get, set]`
	Gets/Sets the list of Records. More...

bool	ReuseValues `[get, set]`
	Gets/Sets a flag indicating whether DataField values should be reused in consecutive Records. More...

Detailed Description

Provides access to JobDataRecordSet (a set of in-memory Record objects which serves as JobData for a Job).

Overview

The JobDataRecordSet is the preferred method to pass data to TFORMer SDK from within program code. Create and fill a JobDataRecordSet and pass it to the Job using JobData.

The JobDataRecordSet represents an in-memory list of Records. Each Record holds a collection of pairs of strings. The first member of such a string-pair denotes the name of the DataField, the second member denotes the value of the DataField.

Although not required it is good practice to set all DataFields used in the FormLayout for each Record. If a DataField which is used in the FormLayout is not present in the JobData its value depends on JobData.ReuseValues.

By default each Record is used for printing exactly once. This behavior can be changed with NumberOfCopies.

More Information

For a general description see JobData.

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

Property Documentation

◆ HandleEscapeSequences

bool HandleEscapeSequences

getsetinherited

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

◆ Records

List<Record> Records

getset

Gets/Sets the list of Records.

Returns: The list of Records

See also: JobDataRecordSet, JobData

◆ ReuseValues

bool ReuseValues