TextDocumentOptions Class

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

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

'Declaration

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

'Usage

Dim instance As TextDocumentOptions

public sealed class TextDocumentOptions : DocumentOptions

@interface LTTextDocumentOptions : LTDocumentOptions <NSCopying, NSCoding>

public class TextDocumentOptions extends DocumentOptions

function Leadtools.Forms.DocumentWriters.TextDocumentOptions()

[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:

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

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.

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

Copy Code

Imports Leadtools.Forms.DocumentWriters
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 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 Text file on disk
   docWriter.EndDocument()
   codecs.Dispose()
End Sub

using Leadtools.Forms.DocumentWriters;
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 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 Text file on disk
   docWriter.EndDocument();
   codecs.Dispose();
}

Target Platforms

Reference

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