loop Property

Summary

Indicates whether to loop to the top or bottom of the search bounds to continue finding the first match.

Syntax

JavaScript Syntax

Object.defineProperty(DocumentViewerFindText.prototype, 'loop', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

loop: boolean;

Property Value

true to loop back around to continue searching in the find text bounds for an initial result; otherwise, false. The default value is true.

Remarks

When FindAll is false, DocumentViewerText.Find only searches until it makes its first match, then exits. If the find text operation starts somewhere between the BeginPosition and EndPosition due to a non-default value set to Start, this means the find text operation could reach the EndPosition without having searched the area from BeginPosition to Start – 1. If Loop is true, the find text operation will conduct a second search from BeginPosition to the character before Start to cover the full search area.

If FindAll is true or Start is BeginPosition, the value of Loop does not matter, as the entire search area will be covered in the single search.

For more information, refer to DocumentViewerText.Find.

History

19.0.0.49: Added - Replaces Recursive

Example

For an example, refer to DocumentViewerText.Find.

Requirements

Target Platforms

Reference

DocumentViewerFindText Class

DocumentViewerFindText Members

Leadtools.Documents.UI Namespace

Help Version 19.0.2017.10.27