Providing Data
[DLL]

TFORMer Runtime retrieves data used for printing a Job from a DataSource. More...

Collaboration diagram for Providing Data:

Functions

ERRCODE TFormer_SetDatasourceName (HTFORM pInstance, LPCSTR pszDatasourceName)
 Specifies the name of the user-defined DataSource.
LPCSTR TFormer_GetDatasourceName (HTFORM pInstance, ERRCODE *peCode)
 Provides the name of the active DataSource of the current FormLayout.
ERRCODE TFormer_SetDSParameterValue (HTFORM pInstance, LPCSTR pszParameterName, LPCSTR pszValue)
 Specifies the value of a DataSource-Parameter.
ERRCODE TFormer_SetDataFile (HTFORM pInstance, LPCSTR pszFileName)
 Sets a XML file in internal TFORMer format as DataSource.
ERRCODE TFormer_ResetData (HTFORM pInstance)
 Resets the data-cache.
ERRCODE TFormer_NewRecord (HTFORM pInstance)
 Appends a new Record to the DataSource.
ERRCODE TFormer_SetRecordCopy (HTFORM pInstance, UINT nRecordCopy)
 Sets the number of copies for the actual Record.
ERRCODE TFormer_SetVarValue (HTFORM pInstance, LPCSTR szVarName, LPCSTR szVarValue)
 Sets the value of a DataField.
ERRCODE TFormer_SetReuseValues (HTFORM pInstance, BOOL bReuse)
 Selects if DataField-values should be reused in consecutive Records.
ERRCODE TFormer_SetHandleEscapeSequences (HTFORM pInstance, BOOL bOn)
 Selects whether escape sequences like \n or \x40 should be translated by TFORMer.
ERRCODE TFormer_SetImportFieldForRecordCopy (HTFORM pInstance, LPCSTR pszFieldName, BOOL bIsAttribute)
 Specifies which DataField in the input controls the number of Record copies.
ERRCODE TFormer_SetTxtDataFile (HTFORM pInstance, LPCSTR pszFileName, CHAR cSeparator, CHAR cTextQualifier)
 Specifies a text-file as DataSource.
ERRCODE TFormer_SetODBCData (HTFORM pInstance, LPCSTR pszDSN, LPCSTR pszUser, LPCSTR pszPwd, LPCSTR pszSQLSelect)
 Specifies an ODBC DataSource.
ERRCODE TFormer_SetXmlDataFile (HTFORM pInstance, LPCSTR pszFileName)
 Specifies a XML-File as DataSource.
ERRCODE TFormer_SetXmlDataFileEx (HTFORM pInstance, LPCSTR pszFileName, LPCSTR pszXsltFileName, LPCSTR pszXsltTFC)
 Specifies a XML-File as DataSource and transforms it with the given XSLT.
ERRCODE TFormer_SaveXml (HTFORM pInstance, LPCSTR pszFileName)
 Saves the actual data as XML File in the internal TFORMer format.

Detailed Description

TFORMer Runtime retrieves data used for printing a Job from a DataSource.

A DataSource is always iterated Record by Record, the order of the records is not changed.

Usually each Record triggers the printing of the detail-band(s) in the FormLayout. Report headers are printed at the top of the first page (above the first page header) after the first Record was read. Report footers are printed at the bottom of the last page after the last Record was read. Page headers and page footers are printed when required; no Record is needed to trigger them. TFORMer requires at least one Record to produce output.

Escape sequences in the values of DataFields are translated into their corresponding binary representation if TFormer_SetHandleEscapeSequences is set to yes.

If a DataField which is used in the FormLayout is not present in the DataSource, then the content of this DataField depends on TFormer_SetReuseValues. By default, TFORMer treats unset DataFields as empty string ("") or 0 (depending on the type of the DataField - see TFormer_ProjectVarItGetType).

If no data is specified for printing a FormLayout, TFORMer Runtime uses the active DataSource (specified in the FormLayout) for printing the Job. If you are printing FormLayouts created with TFORMer Designer 5.1 or earlier, this corresponds to the data entered manually in the last TFORMer Designer session. This data is stored in an extra file (filename.xml) located in the same directory as the FormLayout.

If the DataSource provides more DataFields than defined (either in the stand-alone FormLayout or in the Project of the Repository), these additional DataFields will be ignored.

In order to identify all DataFields in a Project or in a FormLayout use the functions TFormer_GetFirstProjectVarIt and TFormer_GetNextProjectVarIt. If you want to know, whether a returned DataField is actually used in the FormLayout use the function TFormer_ProjectVarItGetUsage.


© 2006-2009 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Wed Sep 2 16:01:09 2009 for TFORMer Runtime DLL/Shared Library with doxygen 1.5.8