Print Interface
The Print Interface object is returned by the CreatePrint function that is provided through the Task Object Connection interface. Through this object, the functionality of the Print utility can be used.
The following functionality is provided:
Properties
| Name | Type | Access | Description |
| AsFile | String | Read/Write | When printing to a printer with in the printer settings the 'Print fo File' checkbox checked, in the filename to print to an asterisk can be used. When printing this asterisk will be replace by the value set in the AsFile property followed by a unique four digit number. |
| BannerFile | String | Read/Write | The name of the bannerfile to use for printing |
| ErrorCode | Integer | Readonly | The error code of the PrintObject. Zero means no error. |
| ErrorDescription | String | Readonly | The description of the error. Is Ok when no error occurred |
| ForcePrint | Boolean | Read/Write | If set to True the file will be printed, otherwise not. |
| NumCopies | Integer | Read/Write | The number of copies to print |
| RemoveFiles | Boolean | Read/Write | If set to True the files will be removed after printing including the entries in the system table |
| SubDirectories | Boolean | Read/Write | If set to True the subdirectories will also be scanned for files to print. |
| Wait |
Boolean |
Read/Write |
If set to True the printcontroller will wait till this print job has finished before starting new print
jobs. |
| WaitTimeOut | Integer | Read/Write | With this property a timeout can be set on print commands. The value given will be in seconds. When set to zero (default) there will be no timeout. |
Functions
| Function Name | Return type | Parameters | Description | |
| Name | Type | |||
| AddFormId | Boolean | FormId | String | When a FormId is added only printfiles printed with the given FormId will be printed. Returns 'True' if successful. |
| AddPrintFile | Integer | FileName | String | Prints the file specified in FileName to the printer specified in Printer. The JobName,
number of Pages to print and the Title of the print can be set. Returns the PrintFile Id. |
| JobName | String | |||
| Pages | Integer | |||
| Title | String | |||
| Printer | String | |||
| ClearSettings | Void | None | None | Clears all the settings from a previous print |
| PrintFile | Integer | FileName | String | Print the file specified in FileName to the printer specified in
Printer. Returns the PrintFile Id if successful, -1 upon failure. |
| Printer | String | |||