Leadtools.Forms.DocumentWriters Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
DocDocumentOptions Class
See Also  Members   Example 
Leadtools.Forms.DocumentWriters Namespace : DocDocumentOptions Class



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

Syntax

Visual Basic (Declaration) 
Public Class DocDocumentOptions 
   Inherits DocumentOptions
Visual Basic (Usage)Copy Code
Dim instance As DocDocumentOptions
C# 
public class DocDocumentOptions : DocumentOptions 
C++/CLI 
public ref class DocDocumentOptions : public DocumentOptions 

Example

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

Visual BasicCopy Code
' Windows API functions needed to load/delete an EMF
<DllImport("gdi32.dll")> _
Private Shared Function GetEnhMetaFile(ByVal lpszMetaFile As String) As IntPtr
End Function
<DllImport("gdi32.dll")> _
Private Shared Function DeleteEnhMetaFile(ByVal hemf As IntPtr) As Boolean
End Function

Private Sub DocDocumentOptionsExample()
   ' Unlock the support needed for LEADTOOLS Document Writers (with PDF output)
   RasterSupport.Unlock(RasterSupportType.DocumentWriters, "Replace with your own key here")

   ' Create a new instance of the LEADTOOLS Document Writer
   Dim docWriter As New DocumentWriter()

   Dim outputFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Test.doc"
   Dim emfFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.emf"

   ' Change the DOC options to add frames to the file
   Dim docOptions As DocDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Doc), DocDocumentOptions)
   docOptions.Framed = True

   ' Use default resolution
   docWriter.SetOptions(DocumentFormat.Doc, docOptions)

   ' Create a new DOC document
   Console.WriteLine("Creating new DOC document: {0}", outputFileName)
   docWriter.BeginDocument(outputFileName, DocumentFormat.Doc)

   ' Use the Windows API to load the EMF
   Dim emfHandle As IntPtr = GetEnhMetaFile(emfFileName)

   ' Add the page
   Dim page As DocumentPage = DocumentPage.Empty
   page.EmfHandle = emfHandle
   page.Image = Nothing

   Console.WriteLine("Adding EMF page from: {0}", emfFileName)
   docWriter.AddPage(page)

   ' Use the Windows API to delete the EMF
   DeleteEnhMetaFile(emfHandle)

   ' Finally finish writing the DOC file on disk
   docWriter.EndDocument()
End Sub
C#Copy Code
// Windows API functions needed to load/delete an EMF 
[DllImport("gdi32.dll")] 
private static extern IntPtr GetEnhMetaFile(string lpszMetaFile); 
[DllImport("gdi32.dll")] 
private static extern bool DeleteEnhMetaFile(IntPtr hemf); 
private void DocDocumentOptionsExample() 

   // Unlock the support needed for LEADTOOLS Document Writers (with PDF output) 
   RasterSupport.Unlock(RasterSupportType.DocumentWriters, "Replace with your own key here"); 
 
   // Create a new instance of the LEADTOOLS Document Writer 
   DocumentWriter docWriter = new DocumentWriter(); 
 
   string outputFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Test.doc"; 
   string emfFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.emf"; 
 
   // Change the DOC options to add frames to the file 
   DocDocumentOptions docOptions = docWriter.GetOptions(DocumentFormat.Doc) as DocDocumentOptions; 
   docOptions.Framed = true; 
 
   docWriter.SetOptions(DocumentFormat.Doc, docOptions); 
 
   // Create a new DOC document 
   Console.WriteLine("Creating new DOC document: {0}", outputFileName); 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Doc); 
 
   // Use the Windows API to load the EMF 
   IntPtr emfHandle = GetEnhMetaFile(emfFileName); 
 
   // Add the page 
   DocumentPage page = DocumentPage.Empty; 
   page.EmfHandle = emfHandle; 
   page.Image = null; 
 
   Console.WriteLine("Adding EMF page from: {0}", emfFileName); 
   docWriter.AddPage(page); 
 
   // Use the Windows API to delete the EMF 
   DeleteEnhMetaFile(emfHandle); 
 
   // Finally finish writing the DOC file on disk 
   docWriter.EndDocument(); 
}

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:
PropertyDescription
DocDocumentOptions.FramedTurn off or on the option to put the text blocks inside a frame (text box object) in the result DOC file.

Inheritance Hierarchy

System.Object
   Leadtools.Forms.DocumentWriters.DocumentOptions
      Leadtools.Forms.DocumentWriters.DocDocumentOptions

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Forms.DocumentWriters requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features