Leadtools.Forms.DocumentWriters Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
GetFormatFriendlyName Method
See Also 
Leadtools.Forms.DocumentWriters Namespace > DocumentWriter Class : GetFormatFriendlyName Method



format
The document format requested.
format
The document format requested.
Gets the friendly name of the specified document format.

Syntax

Visual Basic (Declaration) 
Public Shared Function GetFormatFriendlyName( _
   ByVal format As DocumentFormat _
) As String
Visual Basic (Usage)Copy Code
Dim format As DocumentFormat
Dim value As String
 
value = DocumentWriter.GetFormatFriendlyName(format)
C# 
public static string GetFormatFriendlyName( 
   DocumentFormat format
)
C++/CLI 
public:
static String^ GetFormatFriendlyName( 
   DocumentFormat format
) 

Parameters

format
The document format requested.

Return Value

A String containing the friendly name for the specified format.

Example

For an example, refer to DocumentWriter.

Remarks

This method will return a friendly name used for format. For example, Adobe PDF files will return a string 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 documents.

For more information on the various document formats supported by the LEADTOOLS Document Writers, refer to DocumentFormat.

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

Requirements

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

See Also

Leadtools.Forms.DocumentWriters requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features