[SerializableAttribute()]
[DataContractAttribute()]
public class TextDocumentOptions : DocumentOptions
<DataContractAttribute()>
<SerializableAttribute()>
Public Class TextDocumentOptions
Inherits DocumentOptions
@interface LTTextDocumentOptions : LTDocumentOptions <NSCopying, NSCoding>
public class TextDocumentOptions extends DocumentOptions
[DataContractAttribute()]
[SerializableAttribute()]
public ref class TextDocumentOptions : public DocumentOptions
The options set in the TextDocumentOptions class will be used when the user saves a document using the DocumentFormat.Text format.
To change the options used with the Text format, perform the following steps:
The TextDocumentOptions class contains the following properties:
Property | Description |
---|---|
DocumentType | The type of the Text document (ANSI, UTF8 or UNICODE). |
Formatted | To control whether the output file will be just a flow of text or try to maintain almost the same shape of original page (i.e. margins and lines between paragraphs using spaces). |
AddPageBreak | Add an optional marker between pages in the resulting text file. |
AddPageNumber | Print the page numbers in the resulting text file. |
Note that this format does not support calling DocumentWriter.InsertPage.
This example will create a new text file using the various supported options.
using Leadtools.Document.Writer;
using Leadtools;
using Leadtools.Codecs;
public void TextDocumentOptionsExample()
{
var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf");
var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.txt");
// 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 Text options
var textOptions = docWriter.GetOptions(DocumentFormat.Text) as TextDocumentOptions;
textOptions.DocumentType = TextDocumentType.Ansi;
textOptions.AddPageNumber = true;
textOptions.AddPageBreak = true;
textOptions.Formatted = true;
docWriter.SetOptions(DocumentFormat.Text, textOptions);
// Create a new Text document
Console.WriteLine("Creating new Text document: {0}", outputFileName);
docWriter.BeginDocument(outputFileName, DocumentFormat.Text);
// 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 Text file on disk
docWriter.EndDocument();
codecs.Dispose();
}
static class LEAD_VARS
{
public const string ImagesDir = @"C:\LEADTOOLS21\Resources\Images";
}
Imports Leadtools.Document.Writer
Imports Leadtools
Imports Leadtools.Codecs
Public Sub TextDocumentOptionsExample()
Dim inputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf")
Dim outputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Example.txt")
' 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 Text options
Dim textOptions As TextDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Text), TextDocumentOptions)
textOptions.DocumentType = TextDocumentType.Ansi
textOptions.AddPageNumber = True
textOptions.AddPageBreak = True
textOptions.Formatted = True
docWriter.SetOptions(DocumentFormat.Text, textOptions)
' Create a new Text document
Console.WriteLine("Creating new Text document: {0}", outputFileName)
docWriter.BeginDocument(outputFileName, DocumentFormat.Text)
' 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 Text file on disk
docWriter.EndDocument()
codecs.Dispose()
End Sub
Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\LEADTOOLS21\Resources\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
Your email has been sent to support! Someone should be in touch! If your matter is urgent please come back into chat.
Chat Hours:
Monday - Friday, 8:30am to 6pm ET
Thank you for your feedback!
Please fill out the form again to start a new chat.
All agents are currently offline.
Chat Hours:
Monday - Friday
8:30AM - 6PM EST
To contact us please fill out this form and we will contact you via email.