GetFormatFriendlyName Method

Summary

Gets the friendly name of the specified document format.

Syntax

Objective-C

C++

Java

public static string GetFormatFriendlyName( 
   DocumentFormat format 
)

Public Shared Function GetFormatFriendlyName( _ 
   ByVal format As DocumentFormat _ 
) As String

+ (NSString *)friendlyNameForFormat:(LTDocumentFormat)format

public static String getFormatFriendlyName(DocumentFormat format)

public: 
static String^ GetFormatFriendlyName(  
   DocumentFormat format 
)

Parameters

format
The document format requested.

Return Value

A String containing the friendly name for the specified format.

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

Example

For an example, refer to DocumentWriter.

Requirements

Target Platforms