RasterCodecsInstance Property (IOcrEngine)

RasterCodecs RasterCodecsInstance {get;}

'Declaration
 
ReadOnly Property RasterCodecsInstance As RasterCodecs

'Usage
 
Dim instance As IOcrEngine
Dim value As RasterCodecs
 
value = instance.RasterCodecsInstance

RasterCodecs RasterCodecsInstance {get;}

get_RasterCodecsInstance(); 

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

Property Value

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

The internal Leadtools.Codecs.RasterCodecs object will be disposed of by the engine automatically when Shutdown or System.IDisposable.Dispose is called. If you passed your own instance of Leadtools.Codecs.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 Leadtools.Codecs.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 Leadtools.Codecs.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 Leadtools.Codecs.RasterCodecs to the document Leadtools.Codecs.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.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IOcrEngine Interface
IOcrEngine Members
Startup
IsStarted Property
Shutdown Method
OcrEngineManager Class
OcrEngineType Enumeration
Programming with the LEADTOOLS .NET OCR