TFORMer SDK - NET  7.0
Properties
JobDataRecordSet Class Reference

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

List of all members.

Properties

bool HandleEscapeSequences [get, set]
 
Gets/Sets a flag indicating whether escape sequences in \link TECIT.TFORMer.DataField DataField\endlink values like \\n or \\x40 should be translated by <em>TFORMer SDK</em>.

List< RecordRecords [get, set]
 
Gets/Sets the list of Records.

bool ReuseValues [get, set]
 
Gets/Sets a flag indicating whether \link TECIT.TFORMer.DataField DataField\endlink values should be reused in consecutive Records.


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

bool HandleEscapeSequences [get, set, inherited]

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

Returns:
true if escape sequences in DataField values are translated
See also:
JobData, Escape Sequences
List<Record> Records [get, set]

Gets/Sets the list of Records.

Returns:
The list of Records
See also:
JobDataRecordSet, JobData
bool ReuseValues [get, set, inherited]

Gets/Sets a flag indicating whether \link TECIT.TFORMer.DataField DataField\endlink values should be reused in consecutive Records.

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

© 2006-2012 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Tue Oct 23 2012 16:33:21 for TFORMer SDK - NET with doxygen 1.8.0