GetEngineFormatFileExtension Method

Summary

Gets the default file extension for the specified engine native format.

Syntax

C++

Java

public string GetEngineFormatFileExtension( 
   string formatName 
)

Function GetEngineFormatFileExtension( _ 
   ByVal formatName As String _ 
) As String

public String getEngineFormatFileExtension(String formatName)

String^ GetEngineFormatFileExtension(  
   String^ formatName 
)

Parameters

formatName
The name of the engine native format requested.

Return Value

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

Remarks

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