RtfDocumentOptions Class

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

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

'Declaration

<DataContractAttribute()>
<SerializableAttribute()>
Public Class RtfDocumentOptions 
   Inherits DocumentOptions

'Usage

Dim instance As RtfDocumentOptions

public sealed class RtfDocumentOptions : DocumentOptions

@interface LTRtfDocumentOptions : LTDocumentOptions <NSCopying, NSCoding>

public class RtfDocumentOptions extends DocumentOptions

function Leadtools.Forms.DocumentWriters.RtfDocumentOptions()

[DataContractAttribute()]
[SerializableAttribute()]
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
TextMode	Controls how and when to frames the text blocks in the resulting RTF file.

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

This example will create a new HyperText Markup Language document (RTF) file using the various supported options.

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

Copy Code

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

      
Public Sub RtfDocumentOptionsExample()
   Dim inputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf")
   Dim outputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Example.rtf")
   ' 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 RTF options
   Dim rtfOptions As RtfDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Rtf), RtfDocumentOptions)
   rtfOptions.TextMode = DocumentTextMode.Auto
   docWriter.SetOptions(DocumentFormat.Rtf, rtfOptions)

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

   ' 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 Rtf file on disk
   docWriter.EndDocument()
   codecs.Dispose()
End Sub

using Leadtools.Forms.DocumentWriters;
using Leadtools;
using Leadtools.Codecs;

public void RtfDocumentOptionsExample()
{
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf");
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.rtf");
   // 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 RTF options
   var rtfOptions = docWriter.GetOptions(DocumentFormat.Rtf) as RtfDocumentOptions;
   rtfOptions.TextMode = DocumentTextMode.Auto;
   docWriter.SetOptions(DocumentFormat.Rtf, rtfOptions);

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

   // 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 Rtf file on disk
   docWriter.EndDocument();
   codecs.Dispose();
}

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