RasterCodecsInstance Property

Summary

Gets the instance of the RasterCodecs object being used inside this IOcrEngine.

Syntax

Objective-C

C++

Java

public RasterCodecs RasterCodecsInstance { get; }

ReadOnly Property RasterCodecsInstance As RasterCodecs

@property (nonatomic, strong, readonly) LTRasterCodecs *rasterCodecsInstance

public RasterCodecs getRasterCodecsInstance()

property RasterCodecs^ RasterCodecsInstance { 
   RasterCodecs^ get(); 
}

Property Value

The RasterCodecs object being used inside this IOcrEngine.

Remarks

You can pass an instance of an already initialized RasterCodecs object to the Startup method. This RasterCodecs objects will then be used internally by the engine when loading image files from disk or memory. Otherwise, when passing null (Nothing in VB), the IOcrEngine will create and use its own version of RasterCodecs during the startup procedure.

The internal RasterCodecs object will be disposed of by the engine automatically when Shutdown or Dispose is called. If you passed your own instance of RasterCodecs, then the engine will not dispose it and you can continue to use it as normal after the engine instance has been disposed. When passing your own instance of RasterCodecs, make sure this instance stays valid as long as the engine is started.

When new IOcrDocument objects are created using the IOcrDocumentManager.CreateDocument, a new object of type RasterCodecs is created by this IOcrEngine, and assigned to IOcrDocument.RasterCodecsInstance. All image load and save operation (such as IOcrPageCollection.AddPage, IOcrPageCollection.AddPages, IOcrPageCollection.InsertPage, IOcrPageCollection.InsertPages, IOcrPageCollection.ExportPage and IOcrPageCollection.ExportPages) that is performed inside by OCR document or objects inside the OCR document will use that object.

If the value of IOcrDocument.UseEngineInstanceOptions is true, then the options will be copied from the engine's RasterCodecs to the document RasterCodecs before any methods is called.

For more information on how this object is used by the OCR engine during its lifetime, refer to OCR Engine and RasterCodecs/DocumentWriter Usage.

Example

For an example, refer to Startup.

Requirements

Target Platforms

Reference

OcrEngineManager Class

OcrEngineType Enumeration

Programming with the LEADTOOLS .NET OCR

Download our FREE evaluation

Help Version 20.0.2020.4.2