Syntax of the printTemplate variable of the Print method

bstrPrintTemplate argument of the ICareCreditRequestManager::Print is either empty or of the general form defined below. In the case of an empty bstrPrintTemplate variable, no print variables are changed/substituted and the default print templates are used according to the defined language, law and tiers type.

However, bstrPrintTemplate can be used to change the normal printing behavior or changing the content of printing objects dynamically. The following syntax is used as content of the bstrPrintTemplate variable:

[logTpl][(objectName1=text;...)][=printTemplateFile][#INIPATH=inipath]
where a [] pair defines an optional part. The commands are case insensitive and have the following meaning:

• logTpl: is the logical template name. Currently there is only one template name defined: { detail }.
   
• objectName1=text; does control a substitution of the content of the print object objectName.

  A print object is terminated by a semicolon and all print objects together are enclosed in a () pair.
  There are 3 predefined pseudo print objects with a special meaning:

  • PDF for generating PDF files
  • WEBSTAMP for printing electronic stamps

• printTemplateFile defines an external print template file name (full path + name!).

  If an external print template is supplied it must be mapped against a logical template. Therefore detail=full_vps_filename must be used!

• #INIPATH=inipath defines a fully qualified path to a directory where the report engine searches the corresponding .vpd print template INI file.

  This allows for global settings of a print template in a LAN. The default inipath is the install directory of the Dll

Here are some usage examples:

• bstrPrintTemplate: "" or bstrPrintTemplate: Detail denotes a standard printing situation.
   
• bstrPrintTemplate: detail(DOCUMENT_TITLE_DETAIL=Alternate title for the care title;) prints a substituted title onto the standard print output.
   
• bstrPrintTemplate: detail=C:\myForms\myPrintForm.vps
  uses the print template "C:\myForms\myPrintForm.vps" instead of the default one in the installation directory. An optional INI file with the name "C:\myForms\myPrintForm.vpd" is searched under this condition at the same directory.
   
• bstrPrintTemplate: #INIPATH=\\host1\myForms\
  the default path for the ini files (place of the installed component) is changed to "\\host1\myForms\". If "\\host1\myForms\" is accessible by all hosts of the LAN then the same settings (printer/printing settings) can be used.