LEADTOOLS OCR (Leadtools.Forms.Ocr assembly)

GetEngineFormatFileExtension Method

Show in webframe







The name of the engine native format requested.
Gets the default file extension for the specified engine native format.
Syntax
string GetEngineFormatFileExtension( 
   string formatName
)
'Declaration
 
Function GetEngineFormatFileExtension( _
   ByVal formatName As String _
) As String
'Usage
 
Dim instance As IOcrDocumentManager
Dim formatName As String
Dim value As String
 
value = instance.GetEngineFormatFileExtension(formatName)
string GetEngineFormatFileExtension( 
   string formatName
)

            
public String getEngineFormatFileExtension(String formatName)
function Leadtools.Forms.Ocr.IOcrDocumentManager.GetEngineFormatFileExtension( 
   formatName 
)
String^ GetEngineFormatFileExtension( 
   String^ formatName
) 

Parameters

formatName
The name of the engine native format requested.

Return Value

A System.String containing the file extension for the specified format (without the ".").
Remarks

Some of the OCR engines supported by LEADTOOLS (for example, the OcrEngineType.Plus and OcrEngineType.Professional) support saving 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 returns the default file extension commonly used with file of types formatName. For example, Adobe PDF files commonly have "pdf" extensions, Microsoft Word documents commonly have "doc" extensions and so forth.

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 a friendly name for a specific engine native format, use GetEngineFormatFriendlyName.

Example
For an example, refer to IOcrDocumentManager.
Requirements

Target Platforms

See Also

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

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.

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