GetFormatFileExtension Method

Summary

Gets the default file extension for the specified document format.

Syntax

Objective-C

C++/CLI

Java

Python

public static string GetFormatFileExtension( 
   DocumentFormat format 
)

+ (NSString *)fileExtensionForFormat:(LTDocumentFormat)format

public static String getFormatFileExtension(DocumentFormat format)

public: 
static String^ GetFormatFileExtension(  
   DocumentFormat format 
)

def GetFormatFileExtension(self,format):

Parameters

format
The document format requested.

Return Value

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

Remarks

This method will return the default file extension commonly used with file of types format. For example, Adobe PDF files commonly have "pdf" extensions, Microsoft Word 2003 documents commonly have "doc" extensions and so forth.

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

To get a friendly name for a particular document format use GetFormatFriendlyName.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Ocr; 
 
 
public void DocumentWriterExample() 
{ 
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "test.docx"); 
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.pdf"); 
 
   // Setup a new RasterCodecs object 
   var codecs = new RasterCodecs(); 
   codecs.Options.RasterizeDocument.Load.Resolution = 300; 
 
   // Get the number of pages in the input document 
   var pageCount = codecs.GetTotalPages(inputFileName); 
 
   // Create a new instance of the LEADTOOLS Document Writer 
   var docWriter = new DocumentWriter(); 
 
   // Change the PDF options 
   var pdfOptions = docWriter.GetOptions(DocumentFormat.Pdf) as PdfDocumentOptions; 
   pdfOptions.DocumentType = PdfDocumentType.PdfA; 
   docWriter.SetOptions(DocumentFormat.Pdf, pdfOptions); 
 
   // Create a new PDF document 
   Debug.WriteLine("Creating new PDF document: {0}", outputFileName); 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Pdf); 
 
   // Loop through all the pages 
   for (var pageNumber = 1; pageNumber <= pageCount; pageNumber++) 
   { 
      // Get the page as SVG 
      Debug.WriteLine("Loading page {0}", pageNumber); 
      var page = new DocumentWriterSvgPage(); 
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null); 
 
      // Add the page 
      Debug.WriteLine("Adding page {0}", pageNumber); 
      docWriter.AddPage(page); 
 
      page.SvgDocument.Dispose(); 
   } 
 
   // Finally finish writing the PDF file on disk 
   docWriter.EndDocument(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}