Overridable Function GetFormatFriendlyName( _
   ByVal format As OcrDocumentFormat _
) As String

Visual Basic (Usage)	Copy Code
Dim instance As IOcrDocumentManager Dim format As OcrDocumentFormat Dim value As String   value = instance.GetFormatFriendlyName(format)

virtual string GetFormatFriendlyName( 
   OcrDocumentFormat format
)

virtual String^ GetFormatFriendlyName( 
   OcrDocumentFormat format
) 

Parameters

format

The document format requested.

Return Value

(Deprecated) Use DocumentWriter.GetFormatFriendlyName instead.

This method will return a friendly name used for format. 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 document formats supported by this IOcrEngine, use GetSupportedFormats.

To check if a particular document format is supported by this IOcrEngine, use IsFormatSupported.

To get the file extension for a particular document format, use GetFormatFileExtension.

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

Reference