TextMode Property

Summary

Controls how and when to frames the text blocks in the resulting DOCX file.

Syntax

Objective-C

C++/CLI

Java

Python

public DocumentTextMode TextMode { get; set; }

@property (nonatomic, assign) LTDocumentTextMode textMode;

public DocumentTextMode getTextMode() 
public void setTextMode(DocumentTextMode mode)

public: 
property DocumentTextMode TextMode { 
   DocumentTextMode get(); 
   void set (    DocumentTextMode ); 
}

TextMode # get and set (DocxDocumentOptions)

Property Value

Controls how and when to frames the text blocks in the resulting DOCX file. Default value is DocumentTextMode.Auto.

Remarks

Frames are containers supported by the DOCX format for text that can be positioned on a page and sized.

Example

Java

using Leadtools.Document.Writer; 
using Leadtools; 
using Leadtools.Codecs; 
 
 
public void DocxDocumentOptionsExample() 
{ 
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf"); 
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.docx"); 
 
   // 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 DOCX options to add frames to the file 
   var docxOptions = docWriter.GetOptions(DocumentFormat.Docx) as DocxDocumentOptions; 
   docxOptions.PageRestriction = DocumentPageRestriction.Relaxed; 
   docxOptions.TextMode = DocumentTextMode.Framed; 
   docWriter.SetOptions(DocumentFormat.Docx, docxOptions); 
 
   // Create a new DOCX document 
   Debug.WriteLine("Creating new DOCX document: {0}", outputFileName); 
   docWriter.BeginDocument(outputFileName, DocumentFormat.Docx); 
 
   // 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 DOCX file on disk 
   docWriter.EndDocument(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import static org.junit.Assert.assertTrue; 
 
import java.io.File; 
import java.io.IOException; 
import org.junit.*; 
import org.junit.runner.*; 
import org.junit.runner.notification.Failure; 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.document.writer.*; 
 
 
public void docxDocumentOptionsExample() { 
   Platform.loadLibrary(LTLibrary.DOCUMENT_WRITER); 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS22\\Resources\\Images"; 
 
   String inputFileName = combine(LEAD_VARS_IMAGES_DIR, "Leadtools.pdf"); 
   String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "Example.docx"); 
 
   // 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 DOCX options to add frames to the file 
   DocxDocumentOptions docxOptions = (DocxDocumentOptions) docWriter.getOptions(DocumentFormat.DOCX); 
   docxOptions.setPageRestriction(DocumentPageRestriction.RELAXED); 
   docxOptions.setTextMode(DocumentTextMode.FRAMED); 
   docWriter.setOptions(DocumentFormat.DOCX, docxOptions); 
 
   // Create a new DOCX document 
   System.out.printf("Creating new DOCX document: %s%n", outputFileName); 
   docWriter.beginDocument(outputFileName, DocumentFormat.DOCX); 
 
   // 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 DOCX file on disk 
   docWriter.endDocument(); 
   codecs.dispose(); 
 
   assertTrue(new File(combine(LEAD_VARS_IMAGES_DIR, "Result.jpg")).exists()); 
   System.out.println("Document created successfully to " + combine(LEAD_VARS_IMAGES_DIR, "Result.jpg")); 
 
}