BatchProcessingOptions Object

The BatchProcessingOptions object controls several aspects concerning the document conversion process itself.

Remarks

BatchProcessingOptions object is intended for control of automated document conversion process. Its provides access to several conversion options for documents of some types if special processing method is used, controls log file creation and allows you to limit the number of converted pages in output documents. Some properties of BatchProcessingOptions object are intended for cases when it is needed to control abnormal printing application behavior. But normally you don't need to use such properties as Print2HTML5 Server default settings should handle most of the situations arising during document conversion.

To learn how to use some properties of BatchProcessingOptions object, background information on how Print2HTML5 converts documents is needed which is presented further. Print2HTML5 does not convert any types of documents wholly by itself but it instructs the application that can print documents of a given type to send the printing output to the Print2HTML5 printer where output is intercepted and saved to a Print2HTML5 document file. First, Print2HTML5 looks up which application is registered in the operating system for printing of this kind of document. For example, conversion of .doc files is usually handled by Microsoft Word. Then, Print2HTML5 instructs that application to send the document to the Print2HTML5 Printer. And finally, Print2HTML5 Printer gets a printed representation of the document and saves it to an HTML5 file.

As conversion is performed with the help of external applications, some problems can arise:

1. Application does not start printing regardless of the fact it was instructed to do so
2. Application requires some user interaction before printing can be started, e.g. shows a Print dialog window
3. Application prints a document too long or hangs up during printing
4. Application is not unloaded from memory after printing is completed

It is easy to see that first three problems prevents the document from printing altogether while the last, though allows document conversion, consumes computer memory apparently unnecessarily. By default, Print2HTML5  handles such situations by itself but if you meet with a problem that seems to be of one of the kinds above, you may use BatchProcessingOptions object's abnormal situation control properties to control document conversion process.

There are three possible scenarios of using BatchProcessingOptions object:

• For specifying special (ad hoc) batch processing options  applied to a single conversion or series of conversion. In such a case you should create a BatchProcessingOptions object, setup its properties and pass it to ConvertFile or ConvertDir methods as a BatchProcessingOptions argument;
• For changing default batch processing options applied to all document conversions performed via a single Server object instance. In such a case you should obtain reference to the default batch processing options object using DefaultBatchProcessingOptions property and change its properties. Then you may convert files with this Server object instance and all the options you setup will be applied to all document conversions via this instance;
• For changing global default batch processing options.  In such a case you should obtain a reference to the default batch processing options object using DefaultBatchProcessingOptions property, change its properties and save the changes using ApplyChanges method. 

Object access

To create an ad hoc BatchProcessingOptions object, you need to create it using "Print2HTML5.BatchProcessingOptions" ProgID such as in the following example:

set MyBPOpt=CreateObject("Print2HTML5.BatchProcessingOptions")

Set DefBPOpt=P2H.DefaultBatchProcessingOptions

Here P2H refers to Server object instance.

Regardless of the method you obtained a BatchProcessingOptions object, initially it contains the global default batch processing options setup by Print2HTML5 installation or by the last ApplyChanges method call. After you obtained a reference to BatchProcessingOptions object using one of the methods above, you can access its properties and methods.

Properties
 

Methods
 

ApplyChanges

Method saves the global default batch processing options.

Signature

ApplyChanges()

Arguments

None

Remarks

Method takes the object properties and saves them as the global default batch processing options. If you intend to change the global default batch processing options, you need to call this method to save the changes.

Examples

The following example obtains a default batch processing options object, modifies some of its properties and save the changes back to the global default batch processing options. The example assumes that enumeration constants file P2HAPIConst.vb from Print2HTML5 SDK is included:

Set DefBPOpt=P2H.DefaultBatchProcessingOptions
DefBPOpt.BeforePrintingTimeout = 60000
DefBPOpt.PrintingTimeout = 10000
DefBPOpt.PressPrintButton = TSF_AUTO
DefBPOpt.KillProcessIfTimeout = TSF_YES
DefBPOpt.ApplyChanges

BatchProcessingOptions Object Examples

The sample below creates an ad hoc batch processing options object, sets its properties and use it for conversion of a document named C:\Docs\index.htm

set MyBPOpt=CreateObject("Print2HTML5.BatchProcessingOptions")
MyBPOpt.PressPrintButton = TSF_YES
P2H.ConvertFile "C:\Docs\index.htm", , , MyBPOpt

Set DefBPOpt=P2H.DefaultBatchProcessingOptions
DefBPOpt.AfterPrintingTimeout = 5000
DefBPOpt.CreateLogFile = True
DefBPOpt.LogFileName = "C:\Logs\Print2HTML5Conv.log"
P2H.ConvertDir "C:\Docs"
P2H.ConvertDir "C:\ReadyDocuments"