TextDocumentType Enumeration

Summary

Specifies the Text document type.

Syntax

Objective-C

C++/CLI

Java

Python

[SerializableAttribute()] 
[DataContractAttribute()] 
public enum TextDocumentType

typedef NS_ENUM(NSInteger, LTTextDocumentType) { 
 LTTextDocumentTypeAnsi,  
 LTTextDocumentTypeUnicode,  
 LTTextDocumentTypeUnicodeBigEndian,  
 LTTextDocumentTypeUTF8 
};

public enum TextDocumentType

[DataContractAttribute()] 
[SerializableAttribute()] 
public enum class TextDocumentType

class TextDocumentType(Enum): 
   Ansi = 0 
   Unicode = 1 
   UnicodeBigEndian = 2 
   UTF8 = 3

Members

Value	Member	Description
0	Ansi	The output text document type is ANSI (contains 8-bit ANSI characters only).
1	Unicode	The output text document type is UNICODE (contains 16-bit UNICODE characters).
2	UnicodeBigEndian	The output text document type is UNICODE with Big Endian, the most significant byte (MSB) value is stored at the memory location with the lowest address.
3	UTF8	The output text document type is UTF8.

Remarks

LEADTOOLS Document Writers can create different flavors of Text documents. You can specify the Text document type through the use of the TextDocumentOptions.DocumentType property.

Example

Java

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 
   Debug.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 
      Debug.WriteLine("Loading page {0}", pageNumber); 
      var page = new DocumentWriterSvgPage(); 
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null); 
 
      // Add the page 
      Debug.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:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.document.writer.*; 
 
 
public void textDocumentOptionsExample() { 
   Platform.loadLibrary(LTLibrary.DOCUMENT_WRITER); 
   final String LEAD_VARS_IMAGES_DIR = "c:\\LEADTOOLS23\\Resources\\Images"; 
 
   String inputFileName = combine(LEAD_VARS_IMAGES_DIR, "Leadtools.pdf"); 
   String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "Example.txt"); 
 
   // Setup a new rastercodecs object 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.getOptions().getRasterizeDocument().getLoad().setResolution(300); 
 
   // Get the number of pages in the input document 
   int pageCount = codecs.getTotalPages(inputFileName); 
 
   // Create a new instance of the LEADTOOLS Document Writer 
   DocumentWriter docWriter = new DocumentWriter(); 
 
   // Change the text options 
   TextDocumentOptions textOptions = (TextDocumentOptions) docWriter.getOptions(DocumentFormat.TEXT); 
   textOptions.setDocumentType(TextDocumentType.ANSI); 
   textOptions.setAddPageNumber(true); 
   textOptions.setAddPageBreak(true); 
   textOptions.setFormatted(true); 
   docWriter.setOptions(DocumentFormat.TEXT, textOptions); 
 
   // Create a new text document 
   System.out.printf("Creating new Text document: %s%n", outputFileName); 
   docWriter.beginDocument(outputFileName, DocumentFormat.TEXT); 
 
   // Loop through all the pages 
   for (int pageNumber = 1; pageNumber <= pageCount; pageNumber++) { 
      // Get the page as SVG 
      System.out.printf("Loading page %s%n", pageNumber); 
      DocumentWriterSvgPage page = new DocumentWriterSvgPage(); 
      page.setSvgDocument(codecs.loadSvg(inputFileName, pageNumber, null)); 
 
      // Add the page 
      System.out.printf("Adding page %s%n", pageNumber); 
      docWriter.addPage(page); 
 
      page.getSvgDocument().dispose(); 
   } 
 
   // Finally finish writing the Text file on disk 
   docWriter.endDocument(); 
   codecs.dispose(); 
 
   assertTrue(new File(outputFileName).exists()); 
   System.out.printf("Document created and saved to %s", outputFileName); 
}

Requirements

Target Platforms

Reference

Leadtools.Document.Writer Namespace

Programming with LEADTOOLS Document Writers

Files to be Included with Your Application

Unlocking Special LEAD Features

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document.Writer Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Writer Namespace

Assemblies