←Select platform

Prepare Method

Summary

Prepares to run a job.

Syntax
C#
VB
C++
public void Prepare( 
   StatusJobData jobData 
) 
Public Sub Prepare( 
   ByVal jobData As StatusJobData 
) 
public:  
   void Prepare( 
      StatusJobData^ jobData 
   ) 

Parameters

jobData

Information and options for the job to run. This value must not be null.

Remarks

Prepare will perform the following:

  1. Verify jobData.

  2. Sets or creates the cache(s) required for the conversion.

  3. Sets or creates the DocumentConverter object to use and sets its DocumentWriter and IOcrEngine options.

  4. Updates the DocumentConverter options.

  5. Checks if an annotation rendering engine is available when required (if the value of StatusJobData.AnnotationsMode is Overlay).

  6. Creates an instance of DocumentConverterJobData from the status job data and set it up.

  7. Creates the first status and add it to the status cache.

After this method returns, the application can call Run to run the job and perform the conversion.

Example

For an example, refer to StatusJobDataRunner.

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Converter Assembly