Format Property

Summary

Gets the document format type associated with this options class.

Syntax

Objective-C

C++/CLI

Java

Python

public override DocumentFormat Format { get; }

@property (nonatomic, assign, readonly) LTDocumentFormat format

@Override public DocumentFormat getFormat()

public: 
property DocumentFormat Format { 
   DocumentFormat get() override; 
}

Format # get  (RtfDocumentOptions)

Property Value

This property will always return DocumentFormat.Rtf.

Remarks

This property is required internally by LEADTOOLS.

Example

using Leadtools.Document.Writer; 
using Leadtools; 
using Leadtools.Codecs; 
 
 
public void RtfDocumentOptionsExample() 
{ 
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf"); 
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.rtf"); 
 
   // 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 RTF options 
   var rtfOptions = docWriter.GetOptions(DocumentFormat.Rtf) as RtfDocumentOptions; 
   rtfOptions.TextMode = DocumentTextMode.Auto; 
   docWriter.SetOptions(DocumentFormat.Rtf, rtfOptions); 
 
   // Create a new Rtf document 
   Debug.WriteLine("Creating new Rtf document: {0}", outputFileName); 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Rtf); 
 
   // 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 Rtf file on disk 
   docWriter.EndDocument(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}