GetText() Method

Summary

Gets the text content of this page.

Syntax

C++

Java

public DocumentPageText GetText()

Public Function GetText() As DocumentPageText

public:  
   DocumentPageText^ GetText()

public DocumentPageText getText()

Return Value

The text content of this DocumentPage as a DocumentPageText object.

Remarks

GetText is used to parse the text content of a page. All document types support this method and internally will use the LEADTOOLS SVG or OCR engines to obtain the text from the document.

SetText is used to replace the text content of the page. IsTextModified is used to as flag that indicates that the text of this page has been replaced by the user.

This method works as follows (the "item" is the text content):

If an item was found in the cache, it is returned right away. This is available if the document was created using the cache system. and LEADDocument.CacheOptions contains DocumentCacheOptions.PageText.
The value of DocumentImages.IsSvgSupported and DocumentText.TextExtractionMode will determine if the text is parsed from the page using LEADTOOLS SVG or OCR engines.
If SVG is supported, then GetSvg is called and the text is parsed from the SVG content directly without the use of OCR.
Otherwise, and if OCR is supported, then GetImage is called and the text is parsed from the raster image using OCR.
If this document uses the cache system (LEADDocument.HasCache is true), then the DocumentPageText object is saved to the cache before it is returned. Next time this method is called, the text will be returned from the cache directly without parsing it again.

When the value of DocumentText.AutoParseLinks is true and the page text is first obtained using GetText, then the document will attempt to also parse the text for links based on the regular expressions stored in LinkPatterns.

Note that if SetText has been previously called with a null object for the text parameter, then this method will return null as well.

In all cases, the returned DocumentPageText object is not used by this LEADDocument after it has been returned.

The LEADTOOLS Document Viewer uses this method to obtain the text used with all text operations such Find, Select Text and Text Review annotations objects.

For more information, refer to Parsing Text with the Document Library.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
 
using Leadtools.Document; 
using Leadtools.Caching; 
using Leadtools.Annotations.Engine; 
using Leadtools.Ocr; 
using Leadtools.Barcode; 
using Leadtools.Document.Converter; 
 
public void DocumentPageGetTextExample() 
{ 
	var options = new LoadDocumentOptions(); 
	using (var document = DocumentFactory.LoadFromFile(Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.tif"), options)) 
	{ 
		//for the TIF file we need an OCR engine 
		var ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD); 
		var rasterCodecs = new RasterCodecs(); 
		var documentWriter = new DocumentWriter(); 
		ocrEngine.Startup(rasterCodecs, documentWriter, null, LEAD_VARS.OcrLEADRuntimeDir); 
 
		document.Text.OcrEngine = ocrEngine; 
 
		// get text  
		var page = document.Pages[0]; 
		var pageText = page.GetText(); 
		if (pageText != null) 
		{ 
			pageText.BuildText(); 
			var text = pageText.Text; 
 
			Console.WriteLine(text); 
		} 
		else 
		{ 
			Console.WriteLine("Failed!"); 
		} 
	} 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS21\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS21\Bin\Common\OcrLEADRuntime"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Document.Writer 
Imports Leadtools.Svg 
Imports Leadtools.Document 
Imports Leadtools.Caching 
Imports Leadtools.Annotations.Engine 
Imports Leadtools.Barcode 
Imports Leadtools.Ocr 
Imports LeadtoolsDocumentExamples.LeadtoolsExamples.Common 
Imports Leadtools.Document.Converter 
 
Public Shared Sub DocumentPageGetTextExample() 
   Dim options As New LoadDocumentOptions() 
   Using document As Leadtools.Document.LEADDocument = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Leadtools.tif"), options) 
      'for the TIF file we need an OCR engine 
      Dim ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD) 
      Dim rasterCodecs As New RasterCodecs() 
      Dim documentWriter As New DocumentWriter() 
      ocrEngine.Startup(rasterCodecs, documentWriter, Nothing, LEAD_VARS.OcrLEADRuntimeDir) 
 
      document.Text.OcrEngine = ocrEngine 
 
      ' get text  
      Dim page As Leadtools.Document.DocumentPage = document.Pages(0) 
      Dim pageText As DocumentPageText = page.GetText() 
      If Not pageText Is Nothing Then 
         pageText.BuildText() 
         Dim text As String = pageText.Text 
 
         Console.WriteLine(text) 
      Else 
         Console.WriteLine("Failed!") 
      End If 
   End Using 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const OcrLEADRuntimeDir As String = "C:\LEADTOOLS21\Bin\Common\OcrLEADRuntime" 
End Class

Requirements

Target Platforms

Reference

DocumentPage Class

DocumentPage Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 21.0.2021.7.2

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies