Provides access to a user-defined DataSource, which is defined in the FormLayout or a Repository. More...

Public Member Functions
	JobDataDataSource ()
	Constructor for JobDataDataSource. More...

	JobDataDataSource (string name)
	Constructor for JobDataDataSource. 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...

string	Name `[get, set]`
	Gets/Sets the name of the DataSource. More...

Dictionary< string, string >	ParameterValues `[get, set]`
	Gets/Sets the values for DataSourceParameters. 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 a user-defined DataSource, which is defined in the FormLayout or a Repository.

Overview

The JobDataDataSource enables TFORMer SDK to use a DataSource defined as part of a FormLayout as JobData for printing a Job.

The creator of a FormLayout is able to define such a DataSource with TFORMer Designer. This DataSource definition is stored as part of the FormLayout and is identified by a unique name. It defines how data is retrieved (e.g. from an ODBC database), the field-mappings and optional DataSourceParameters.

If you specify no or an empty name when using the JobDataDataSource, TFORMer SDK uses the default DataSource specified in the FormLayout. The default JobDataDataSource stores the DataField values used during the last TFORMer Designer session (for this purpose TFORMer Designer maintains an extra file with the extension .xml). If no file with default data exists TFORMer SDK produces no output.

The optional DataSourceParameters may be used to control certain aspects of the JobDataDataSource (like file names, SQL SELECT statement or an ODBC-DSN) during runtime.

Examples

Sample tff has no datasource (remove Sample?) move it to samples ?

The following sample will use a predefined DataSource. Set one DataSourceParameter and send the output to the default printer.

More Information

For a general description see JobData.

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

Constructor & Destructor Documentation

◆ JobDataDataSource() [1/2]

JobDataDataSource ( )

Constructor for JobDataDataSource.

Initializes a new instance of JobDataDataSource class.

◆ JobDataDataSource() [2/2]

JobDataDataSource ( string name )

Constructor for JobDataDataSource.

Initializes a new instance of JobDataDataSource class.

Parameters

name	The name of the DataSource in the FormLayout or in the Repository

See also: JobDataDataSource, DataSource

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

◆ Name

string Name

getset

Gets/Sets the name of the DataSource.

Returns: The name of the DataSource in the FormLayout or in the Repository

If no name or an empty string was specified, then TFORMer SDK uses the default DataSource.

See also: JobData, JobDataDataSource, DataSource

◆ ParameterValues

Dictionary<string, string> ParameterValues