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



formatName
The name of the engine native format requested.

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

formatName
The name of the engine native format requested.
Gets the default file extension for the specified engine native format.

Syntax

Visual Basic (Declaration) 
Function GetEngineFormatFileExtension( _
   ByVal formatName As String _
) As String
Visual Basic (Usage)Copy Code
Dim instance As IOcrDocumentManager
Dim formatName As String
Dim value As String
 
value = instance.GetEngineFormatFileExtension(formatName)
C# 
string GetEngineFormatFileExtension( 
   string formatName
)
C++/CLI 
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 ".").

Example

For an example, refer to IOcrDocumentManager.

Remarks

Some of the OCR engines supported by LEADTOOLS (for example, the OcrEngineType.Plus and OcrEngineType.Professional supports saving the recognition result using the engine native save mechanism instead of the LEADTOOLS Document Writers. Use the GetEngineSupportedFormats 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 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.

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 GetEngineSupportedFormats.

To check if a particular engine native format is supported by this IOcrEngine, use IsEngineFormatSupported.

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

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

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