LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
RasterCodecsInstance Property
See Also 
Leadtools.Forms.Ocr Namespace > IOcrDocument Interface : RasterCodecsInstance Property



The RasterCodecsInstance Property is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

Gets the instance of the Leadtools.Codecs.RasterCodecs object being used inside this IOcrDocument.

Syntax

Visual Basic (Declaration) 
ReadOnly Property RasterCodecsInstance As RasterCodecs
Visual Basic (Usage)Copy Code
Dim instance As IOcrDocument
Dim value As RasterCodecs
 
value = instance.RasterCodecsInstance
C# 
RasterCodecs RasterCodecsInstance {get;}
C++/CLI 
property RasterCodecs^ RasterCodecsInstance {
   RasterCodecs^ get();
}

Property Value

The Leadtools.Codecs.RasterCodecs object being used inside this IOcrDocument.

Example

For an example, UseEngineInstanceOptions.

Remarks

The Leadtools.Codecs.RasterCodecs object will be disposed of by the document automatically when System.IDisposable.Dispose is called.

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

RasterCodecsInstance requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features