DocDocumentOptions Class

Summary

Provides extra options to use when saving a document using the Microsoft Word 2003 document format (DOC) format.

Syntax

C++/CLI

Java

Python

[SerializableAttribute()] 
[DataContractAttribute()] 
public class DocDocumentOptions : DocumentOptions

public class DocDocumentOptions extends DocumentOptions

[DataContractAttribute()] 
[SerializableAttribute()] 
public ref class DocDocumentOptions : public DocumentOptions

class DocDocumentOptions(DocumentOptions):

Remarks

The options set in the DocDocumentOptions class will be used when the user saves a document using the DocumentFormat.Doc format.

To change the options used with the DOC format, perform the following steps:

Use the DocumentWriter.GetOptions method of the DocumentWriter object being used. Passing DocumentFormat.Doc to the format parameter. Note that the resulting object from the base DocumentOptions class needs to be cast to DocDocumentOptions.
Use the various DocDocumentOptions properties to change the options.
Use DocumentWriter.SetOptions to set the new options in the engine.
Now you can call the DocumentWriter.BeginDocument method (with DocumentFormat.Doc for the format parameter) to create a new document and add the pages.

The DocDocumentOptions class contains the following properties:

Property	Description
DocDocumentOptions.TextMode	Controls how and when to frames the text blocks in the resulting DOC file.

Note that this format does not support calling DocumentWriter.InsertPage.

Example

This example will create a new Microsoft Word 2003 document (DOC) file using some of the supported options.

Java

using Leadtools.Document.Writer; 
using Leadtools; 
using Leadtools.Codecs; 
 
 
public void DocDocumentOptionsExample() 
{ 
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf"); 
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.doc"); 
 
   // 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 DOC options to add frames to the file 
   var docOptions = docWriter.GetOptions(DocumentFormat.Doc) as DocDocumentOptions; 
   docOptions.TextMode = DocumentTextMode.Framed; 
   docWriter.SetOptions(DocumentFormat.Doc, docOptions); 
 
   // Create a new DOC document 
   Debug.WriteLine("Creating new DOC document: {0}", outputFileName); 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Doc); 
 
   // 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 DOC file on disk 
   docWriter.EndDocument(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.runner.Result; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.codecs.*; 
import leadtools.document.writer.*; 
 
 
public void docDocumentOptionsExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String inputFileName = combine(LEAD_VARS_IMAGES_DIR, "Leadtools.pdf"); 
   String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "Example.doc"); 
 
   // Setup a new RasterCodecs object 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.getOptions().getRasterizeDocument().getLoad().setResolution(300); 
 
   // Get the number of pages in the input document 
   int pageCount = codecs.getTotalPages(inputFileName); 
 
   // Create a new instance of the LEADTOOLS Document Writer 
   DocumentWriter docWriter = new DocumentWriter(); 
 
   // Change the DOC options to add frames to the file 
   DocDocumentOptions docOptions = (DocDocumentOptions) docWriter.getOptions(DocumentFormat.DOC); 
   docOptions.setTextMode(DocumentTextMode.FRAMED); 
   docWriter.setOptions(DocumentFormat.DOC, docOptions); 
 
   // Create a new DOC document 
   System.out.printf("Creating new DOC document: %s%n", outputFileName); 
   docWriter.beginDocument(outputFileName, DocumentFormat.DOC); 
 
   // Loop through all the pages 
   for (var pageNumber = 1; pageNumber <= pageCount; pageNumber++) { 
      // Get the page as SVG 
      System.out.printf("Loading page %s%n", pageNumber); 
      var page = new DocumentWriterSvgPage(); 
      page.setSvgDocument(codecs.loadSvg(inputFileName, pageNumber, null)); 
 
      // Add the page 
      System.out.printf("Adding page %s%n", pageNumber); 
      docWriter.addPage(page); 
      page.getSvgDocument().dispose(); 
   } 
 
   // Finally finish writing the DOC file on disk 
   docWriter.endDocument(); 
   codecs.dispose(); 
 
   assertTrue("File created unsuccessfully", (new File(outputFileName)).exists()); 
   System.out.println("File created and saved to " + outputFileName); 
}