Public Member Functions |
| JobDataDataSource () |
| Constructor for JobDataDataSource.
|
| JobDataDataSource (string name) |
| Constructor for JobDataDataSource.
|
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>.
|
string | Name [get, set] |
| Gets/Sets the name of the \link TECIT.TFORMer.DataSource DataSource\endlink.
|
Dictionary< string, string > | ParameterValues [get, set] |
| Gets/Sets the values for DataSourceParameters.
|
bool | ReuseValues [get, set] |
| Gets/Sets a flag indicating whether \link TECIT.TFORMer.DataField DataField\endlink values should be reused in consecutive Records.
|
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.
Job printJob = new Job();
printJob.RepositoryName = @"C:\Documents and Settings\All Users\Application Data\TEC-IT\TFORMer\7.0\Templates\(6) Samples_Picking List.tff";
JobDataDataSource jobData = new JobDataDataSource("ODBC");
jobData.ParameterValues.Add ("PickingListParameter", "2");
printJob.JobData = jobData;
printJob.OutputName = "/temp/out.pdf";
printJob.PrinterType = PrinterType.PdfFile;
printJob.Print();
More Information
For a general description see
JobData.
- Note:
- Thread-safety: A single instance of this class must not be used by different threads.