Overridable Function GetEngineFormatFriendlyName( _
   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.GetEngineFormatFriendlyName(formatName)

virtual string GetEngineFormatFriendlyName( 
   string formatName
)

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

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

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

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

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Reference