EngineFormat Property

Summary

Gets or sets the name of the engine native format to use when saving OCR documents.

Syntax

C++

Java

public string EngineFormat { get; set; }

Property EngineFormat As String

public String getEngineFormat() 
public void setEngineFormat(String value)

property String^ EngineFormat { 
   String^ get(); 
   void set (    String^ ); 
}

Property Value

A String that indicates the name of the engine native format to use when saving OCR documents.

Remarks

Some of the OCR engines supported by LEADTOOLS (for example, the OcrEngineType.OmniPage) support saving the recognition results using the engine native save mechanism instead of the LEADTOOLS Document Writers. Use the GetSupportedEngineFormats method to get a list of the names of the native formats and the EngineFormat property to set the format to use when saving the results.

It is recommended that you use the LEADTOOLS Document Writers supported formats always when saving OCR recognition data. For more information refer to DocumentFormat. Support for native engine formats may be deprecated in later versions of LEADTOOLS.

To save the recognition results using the engine native format:

Obtain the engine native format name through the GetSupportedEngineFormats.
Set the engine format name in the EngineFormat property
Call the various save methods (IOcrDocument.Save or IAutoRecognizeManager.Run) using DocumentFormat.User for the format parameter.

Note that the LEADTOOLS default installation does not ship with native engine format support. You must download and install the "OCR Additional Features" setup available at https://www.leadtools.com to add this feature. To get a list of the engine native formats available but not installed for the current OCR engine, use GetAdditionalEngineFormats.

For more information on the various document formats supported by LEADTOOLS refer to DocumentFormat.

To get a list of all the engine native formats supported by this IOcrEngine, use GetSupportedEngineFormats.

To determine whether a specific engine native format is supported by this IOcrEngine, use IsEngineFormatSupported.

To get the file extension for a specific engine native format, use GetEngineFormatFileExtension.

To get a friendly name for a specific engine native format, use GetEngineFormatFriendlyName.

Example

For an example, refer to IOcrDocumentManager.

Requirements

Target Platforms

Reference

IOcrDocumentManager Interface

IOcrDocumentManager Members

Leadtools.Document.Writer.DocumentFormat

IOcrDocument Interface

OcrEngineManager Class

OcrEngineType Enumeration

Programming with the LEADTOOLS .NET OCR

Files to be Included with Your Application

Download our FREE evaluation

Help Version 20.0.2020.4.2