←Select platform

DocDocumentOptions Class

Summary

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

Syntax

C#
VB
Java
C++
[SerializableAttribute()] 
[DataContractAttribute()] 
public class DocDocumentOptions : DocumentOptions 
<DataContractAttribute()> 
<SerializableAttribute()> 
Public Class DocDocumentOptions  
   Inherits Leadtools.Forms.Documentwriters.DocumentOptions 
public class DocDocumentOptions extends DocumentOptions 
[DataContractAttribute()] 
[SerializableAttribute()] 
public ref class DocDocumentOptions : public Leadtools.Forms.Documentwriters.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:

  1. 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.
  2. Use the various DocDocumentOptions properties to change the options.
  3. Use DocumentWriter.SetOptions to set the new options in the engine.
  4. 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.

C#
VB
using Leadtools.Forms.DocumentWriters; 
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 
   Console.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 
      Console.WriteLine("Loading page {0}", pageNumber); 
      var page = new DocumentSvgPage(); 
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null); 
 
      // Add the page 
      Console.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:\Users\Public\Documents\LEADTOOLS Images"; 
} 
Imports Leadtools.Forms.DocumentWriters 
Imports Leadtools 
Imports Leadtools.Codecs 
 
Public Sub DocDocumentOptionsExample() 
   Dim inputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf") 
   Dim outputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Example.doc") 
 
   ' Setup a new RasterCodecs object 
   Dim codecs As New RasterCodecs() 
   codecs.Options.RasterizeDocument.Load.Resolution = 300 
 
   ' Get the number of pages in the input document 
   Dim pageCount As Integer = codecs.GetTotalPages(inputFileName) 
 
   ' Create a new instance of the LEADTOOLS Document Writer 
   Dim docWriter As New DocumentWriter() 
 
   ' Change the DOC options to add frames to the file 
   Dim docOptions As DocDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Doc), DocDocumentOptions) 
   docOptions.TextMode = DocumentTextMode.Framed 
   docWriter.SetOptions(DocumentFormat.Doc, docOptions) 
 
   ' Create a new DOC document 
   Console.WriteLine("Creating new DOC document: {0}", outputFileName) 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Doc) 
 
   ' Loop through all the pages 
   For pageNumber As Integer = 1 To pageCount 
      ' Get the page as SVG 
      Console.WriteLine("Loading page {0}", pageNumber) 
      Dim page As New DocumentSvgPage() 
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, Nothing) 
 
      ' Add the page 
      Console.WriteLine("Adding page {0}", pageNumber) 
      docWriter.AddPage(page) 
 
      page.SvgDocument.Dispose() 
   Next 
 
   ' Finally finish writing the DOC file on disk 
   docWriter.EndDocument() 
   codecs.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Forms.DocumentWriters Assembly
Introduction
Getting Started
Namespaces
Leadtools.Forms.DocumentWriters Namespace
Assemblies