TFORMer SDK - NET  8
Public Member Functions | Properties
JobDataOdbc Class Reference

Provides access to JobDataOdbc (an ODBC connection that serves as JobData for a Job). More...

List of all members.

Public Member Functions

 JobDataOdbc ()
 Constructor for JobDataOdbc.
 JobDataOdbc (string dsn, string user, string password, string sqlSelect)
 Constructor for JobDataOdbc.

Properties

string Dsn [get, set]
 Gets/Sets the DSN (ODBC data-source-name).
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.
string Password [get, set]
 Gets/Sets the password for the database connection.
string RecordCopyDataField [get, set]
 Gets/Sets the name of the DataField which specifies the number of Record copies.
bool ReuseValues [get, set]
 Gets/Sets a flag indicating whether DataField values should be reused in consecutive Records.
string SqlSelect [get, set]
 Gets/Sets the SQL select statement for fetching the records from the database.
string User [get, set]
 Gets/Sets the user-name for the database connection.

Detailed Description

Provides access to JobDataOdbc (an ODBC connection that serves as JobData for a Job).

Overview

The JobDataOdbc enables TFORMer SDK to use arbitrary database-tables or queries as JobData for printing a Job.

The data in such a table provides the values of the DataFields. The table is read Record by Record using the specified SQL SELECT statement. TFORMer SDK matches the column-names of the table or query with the corresponding DataField names in the FormLayout. If required use SQL aliases to provide identical column names.

The order of the columns in the table or query does not matter.

The DSN represents the name of the database connection as defined in the Microsoft Windows Control Panel. Please keep in mind that the DSN is a part of the connection string and thus a complete specification is required.

This may yield the following code:

  // Set the DSN programmatically
  jobDataOdbc.Dsn = "DSN=TFORMer_Sample";

Example

This example demonstrates how to use the pre-installed ODBC data-source (named TFORMer_Sample) for generating a report as PDF. The table tbl_Example looks like follows:

ChapterNumber Caption PageNumber
1 Content 2
1.1 Table of Figures 6
1.2 List of Tables 6
2 Disclaimer 7
... ... ...

This is the code to use this table as a JobDataOdbc:

  // Create a new Job instance
  Job printJob = new Job();

  // Select the stand-alone FormLayout named ODBCReportPDF.tff
  // This FormLayout is usually installed as part of the TFORMer Examples in
  // - Windows Vista or later: C:/Program Data/TEC-IT/TFORMer/8/Examples
  // - Older Microsoft Windows versions: C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/8/Examples
  printJob.RepositoryName = "C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/8/Examples/Command Line/ODBCReportPDF/ODBCReportPDF.tff";

  // Create a new JobData instance using the installed sample ODBC connection named TFORMer_Sample 
  JobData jobData = new JobDataOdbc("DSN=TFORMer_Sample", "", "", "SELECT  FROM tbl_Example");

  // Assign the JobData to the Job
  printJob.JobData = jobData;

  // Select PDF output to /temp/out.pdf 
  printJob.OutputName = "/temp/out.pdf";
  printJob.PrinterType = PrinterType.PdfFile;

  // Generate output based on the FormLayout and the JobData
  printJob.Print ();

More Information

For a general description see JobData.

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

Constructor & Destructor Documentation

Constructor for JobDataOdbc.

Initializes a new instance of the JobDataOdbc class.

JobDataOdbc ( string  dsn,
string  user,
string  password,
string  sqlSelect 
)

Constructor for JobDataOdbc.

Initializes a new instance of the JobDataOdbc class.

Parameters:
dsnThe DSN (ODBC data-source name)
userThe (optional, may be empty) user name as required by the ODBC connection
passwordThe (optional, may be empty) password as required by the ODBC connection
sqlSelectThe SQL-SELECT statement

Property Documentation

string Dsn [get, set]

Gets/Sets the DSN (ODBC data-source-name).

Returns:
The DSN
See also:
JobDataOdbc
bool HandleEscapeSequences [get, set, inherited]

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
string Password [get, set]

Gets/Sets the password for the database connection.

Returns:
The password for the DSN (optional)

It depends on the database connection if the password is required or not.

string RecordCopyDataField [get, set]

Gets/Sets the name of the DataField which specifies the number of Record copies.

TFORMer SDK allows you to specify how often one Record of a JobData should be used for printing. This property specifies which DataField specifies the number of copies for each Record of the JobData.

Returns:
The name of the DataField which holds the number of Record copies
See also:
JobData, DataField
bool ReuseValues [get, set, inherited]

Gets/Sets a flag indicating whether DataField values should be reused in consecutive Records.

Returns:
false if DataField-values should be cleared between Records
See also:
JobData, DataField
string SqlSelect [get, set]

Gets/Sets the SQL select statement for fetching the records from the database.

Returns:
The SQL select statement (required)
string User [get, set]

Gets/Sets the user-name for the database connection.

Returns:
The user-name for the DSN (optional)

It depends on the database connection if the user-name is required or not.


© 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