UseEngineInstanceOptions Property

Summary

Gets or sets a value indicating whether this IOcrDocument must copy the RasterCodecs and DocumentWriter options from the IOcrEngine before using them.

Syntax

Objective-C

C++/CLI

Java

Python

public bool UseEngineInstanceOptions { get; set; }

@property (nonatomic, assign) BOOL useEngineInstanceOptions

public boolean getUseEngineInstanceOptions() 
public void setUseEngineInstanceOptions(boolean value)

property bool UseEngineInstanceOptions { 
   bool get(); 
   void set (    bool ); 
}

UseEngineInstanceOptions # get and set (IOcrDocument)

Property Value

true if this IOcrDocument must copy the RasterCodecs and DocumentWriter options from the IOcrEngine before using them; otherwise, false. Default value is true.

Remarks

When the value of this property is true, then this IOcrDocument will copy the options from IOcrEngine.RasterCodecsInstance and IOcrEngine.DocumentWriterInstance to IOcrDocument.RasterCodecsInstance and IOcrDocument.DocumentWriterInstance before using them.

This makes it easy to change RasterCodecs and DocumentWriter options globally for all current and future IOcrDocument's.

If you have a requirement to use different options per IOcrDocument in the same IOcrEngine, for example, you have an IOcrDocument object that will save to PDF with Image/Text option and another to save to PDF/A. Then you can set UseEngineInstanceOptions of each document to false, then change the PDF options through DocumentWriterInstance instead of DocumentWriterInstance.

The options are copied before any of the following methods is called:

For more information, refer to OCR Engine and RasterCodecs/DocumentWriter Usage.

Requirements

Target Platforms

Reference

IOcrDocument Interface

IOcrDocument Members

OcrEngineManager Class

OcrEngineType Enumeration

RasterCodecsInstance Property

DocumentWriterInstance Property

IOcrEngine.RasterCodecsInstance

IOcrEngine.DocumentWriterInstance

Programming with the LEADTOOLS .NET OCR

Download our FREE evaluation

Help Version 23.0.2024.3.3