GetEngineFormatFriendlyName Method

string GetEngineFormatFriendlyName( 
   string formatName
)

'Declaration
 
Function GetEngineFormatFriendlyName( _
   ByVal formatName As String _
) As String

'Usage
 
Dim instance As IOcrDocumentManager
Dim formatName As String
Dim value As String
 
value = instance.GetEngineFormatFriendlyName(formatName)

string GetEngineFormatFriendlyName( 
   string formatName
)

public String getEngineFormatFriendlyName(String formatName)

function Leadtools.Forms.Ocr.IOcrDocumentManager.GetEngineFormatFriendlyName( 
   formatName 
)

String^ GetEngineFormatFriendlyName( 
   String^ formatName
) 

Parameters

formatName

The engine native format name requested.

Return Value

Some of the OCR engines supported by LEADTOOLS (for example, the OcrEngineType.Plus and OcrEngineType.Professional) 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.

This method will return a friendly name used for formatName. For example, Adobe PDF files will return something similar to "Adobe PDF" and Microsoft Word documents will return "Microsoft Word" and so forth. You can use this value in your application when presenting the user with a list to select a format to save the recognized OCR documents.

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 http://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 Leadtools.Forms.DocumentWriters.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.

Target Platforms

Reference

IOcrDocumentManager Interface
IOcrDocumentManager Members
Leadtools.Forms.DocumentWriters.DocumentFormat
IOcrDocument Interface
IOcrDocument.Save
IOcrDocument.SaveXml
IOcrPage.Recognize
IOcrEngine Interface
OcrEngineManager Class
OcrEngineType Enumeration
Programming with the LEADTOOLS .NET OCR
Files to be Included with Your Application