selectFirstResult Property

Summary

Indicates whether to select and bring the first result of the FindText operation into view.

Syntax

JavaScript Syntax

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

TypeScript Syntax

selectFirstResult: boolean;

Property Value

true to set the first result from the Find Text operation as the selected text and scroll to it in the DocumentViewer.View; otherwise false. The default value is true.

Remarks

All results for DocumentViewerText.Find will be available after the operation concludes. The results will be in order - by default the search's initial position is BeginPosition, but this may vary based on Start.

If SelectFirstResult is true, the first match in this list will automatically be set to the selected text (clearing any previous selected text) and brought into view. This can still be done manually if SelectFirstResult is false by using the bounds of the first result with DocumentViewerText.SetSelectedTextItems and ImageViewer.EnsureBoundsVisible.

To control whether a single match or all matches are returned, use FindAll. To highlight the results, see RenderResults.

For more information, refer to DocumentViewerText.Find.

History

19.0.0.49: Added

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