AddPageBreak Property

Summary

Indicates whether the resulting text file should have page breaks.

Syntax

Objective-C

C++/CLI

Java

Python

public bool AddPageBreak { get; set; }

@property (nonatomic, assign) BOOL addPageBreak;

public boolean getAddPageBreak() 
public void setAddPageBreak(boolean addPageBreak)

public: 
property bool AddPageBreak { 
   bool get(); 
   void set (    bool ); 
}

AddPageBreak # get and set (TextDocumentOptions)

Property Value

true to add page breaks in the final text document, otherwise; false. Default value is false.

Remarks

Page breaks are markers which indicate the end of a page. The text format is not a multipage format and so this property helps to determine the end of page.

The default value of this property is false.

Example

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:\LEADTOOLS22\Resources\Images"; 
}