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



Provides extra options to use when saving a document using the Microsoft Rich Text Format (RTF).

Syntax

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

Example

This example will create a new HyperText Markup Language document (RTF) 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 RtfDocumentOptionsExample()
   ' 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.rtf"
   Dim emfFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.emf"

   ' Change the RTF options to add frames to the file
   dim rtfOptions as RtfDocumentOptions = directcast(docWriter.GetOptions(DocumentFormat.Rtf) , RtfDocumentOptions)
   rtfOptions.Framed = True

   docWriter.SetOptions(DocumentFormat.Rtf, rtfOptions)

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

   ' 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 RTF 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 RtfDocumentOptionsExample() 

   // 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.rtf"; 
   string emfFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Ocr1.emf"; 
 
   // Change the RTF options to add frames to the file 
   RtfDocumentOptions rtfOptions = docWriter.GetOptions(DocumentFormat.Rtf) as RtfDocumentOptions; 
   rtfOptions.Framed = true; 
 
   docWriter.SetOptions(DocumentFormat.Rtf, rtfOptions); 
 
   // Create a new RTF document 
   Console.WriteLine("Creating new RTF document: {0}", outputFileName); 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Rtf); 
 
   // 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 RTF file on disk 
   docWriter.EndDocument(); 
}

Remarks

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

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

  1. Use the DocumentWriter.GetOptions method of the DocumentWriter object being used. Passing DocumentFormat.Rtf to the Format parameter. Note that the resulting object from the base DocumentOptions class needs to be cast to RtfDocumentOptions.
  2. Use the various RtfDocumentOptions 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.Rtf for the format parameter) to create a new document and add the pages.

The RtfDocumentOptions class contains the following properties:
PropertyDescription
RtfDocumentOptions.FramedTurn off or on the option to put the text blocks inside a frame (text box object) in the resulting RTF file.

Inheritance Hierarchy

System.Object
   Leadtools.Forms.DocumentWriters.DocumentOptions
      Leadtools.Forms.DocumentWriters.RtfDocumentOptions

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