RtfDocumentOptions Class

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public class RtfDocumentOptions : DocumentOptions

'Declaration
 
Public Class RtfDocumentOptions 
   Inherits DocumentOptions

'Usage
 
Dim instance As RtfDocumentOptions

public sealed class RtfDocumentOptions : DocumentOptions

function Leadtools.Forms.DocumentWriters.RtfDocumentOptions()

public ref class RtfDocumentOptions : public DocumentOptions

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:

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.
Use the various RtfDocumentOptions 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.Rtf for the format parameter) to create a new document and add the pages.

The RtfDocumentOptions class contains the following properties:

Property	Description
RtfDocumentOptions.Framed	Turn off or on the option to put the text blocks inside a frame (text box object) in the resulting RTF file.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools.Forms.DocumentWriters
Imports Leadtools
Imports Leadtools.Codecs

' 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 = Path.Combine(LEAD_VARS.ImagesDir, "Test.rtf")
   Dim emfFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "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

using Leadtools.Forms.DocumentWriters;
using Leadtools;

// 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()
{
   // Create a new instance of the LEADTOOLS Document Writer
   DocumentWriter docWriter = new DocumentWriter();

   string outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Test.rtf");
   string emfFileName = Path.Combine(LEAD_VARS.ImagesDir, "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();
}

Target Platforms

Reference

RtfDocumentOptions Members
Leadtools.Forms.DocumentWriters Namespace
DocumentWriter Class
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features