Provides extra options to use when saving a document using the Rich Text Format (RTF).
[SerializableAttribute()]
[DataContractAttribute()]
public class RtfDocumentOptions : DocumentOptions
<DataContractAttribute()>
<SerializableAttribute()>
Public Class RtfDocumentOptions
Inherits DocumentOptions
@interface LTRtfDocumentOptions : LTDocumentOptions <NSCopying, NSCoding>
public class RtfDocumentOptions extends DocumentOptions
[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:
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.
using Leadtools.Document.Writer;
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 DocumentWriterSvgPage();
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();
}
static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
Imports Leadtools.Document.Writer
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 DocumentWriterSvgPage()
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
Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
Leadtools.Document.Writer Namespace
Programming with LEADTOOLS Document Writers
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document