ClipText Method

Summary

Creates a new DocumentPageText from a portion of this text data.

Syntax

C++

Java

public DocumentPageText ClipText( 
   LeadRectD bounds 
)

Public Function ClipText( 
   ByVal bounds As LeadRectD 
) As DocumentPageText

public:  
   DocumentPageText^ ClipText( 
      LeadRectD^ bounds 
   )

public DocumentPageText clipText(LeadRectD bounds)

Parameters

bounds

The area to clone. This value is in document coordinates.

Return Value

New DocumentPageText that contains only the characters that are included in bounds.

Remarks

Use this method to create a copy of DocumentPageText that contains only the characters that intersect with a specified rectangle. For example, if your application contains functionality where the user can select a portion of the page using rubber band to extract text from, then you can use ClipText on the page object to return a new object that can be used with BuildWords or BuildText to parse only the words and text of the area.

ClipText works by checking the value of DocumentCharacter.Bounds of each item in Characters by intersecting with bounds. If the value intersects, then it is added to the Characters list of the new object.

If the value of bounds is empty (IsEmpty), then this method returns an exact copy of this DocumentPageText.

bounds must be in document coordinates. Refer to Document Library Coordinate System for more information.

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 DocumentPageTextClipTextExample() 
{ 
	var options = new LoadDocumentOptions(); 
	using (var document = DocumentFactory.LoadFromFile(Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.doc"), options)) 
	{ 
		LeadRect clipPixels = LeadRect.FromLTRB(1337, 300, 1545, 347); 
		LeadRectD clipDocument = document.RectToDocument(clipPixels); 
 
		// get text  
		var page = document.Pages[0]; 
		var pageText = page.GetText().ClipText(clipDocument); 
		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"; 
}

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 DocumentPageTextClipTextExample() 
   Dim options As New LoadDocumentOptions() 
   Using document As Leadtools.Document.LEADDocument = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Leadtools.doc"), options) 
      Dim clipPixels As LeadRect = LeadRect.FromLTRB(1337, 300, 1545, 347) 
      Dim clipDocument As LeadRectD = document.RectToDocument(clipPixels) 
 
      ' get text  
      Dim page As Leadtools.Document.DocumentPage = document.Pages(0) 
      Dim pageText As DocumentPageText = page.GetText().ClipText(clipDocument) 
      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

Requirements

Target Platforms

Reference

DocumentPageText Class

DocumentPageText 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