In This Topic ▼

start Property

Summary

Indicates where to start finding text within the bounds of a Find Text operation.

Syntax

TypeScript

JavaScript

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

start: DocumentViewerFindTextStart;

Property Value

An enumeration value from DocumentViewerFindTextStart that indicates where the text search should start. The default value is DocumentViewerFindTextStart.BeginPosition, which creates one search starting from BeginPosition and stopping at EndPosition.

Remarks

BeginPosition and EndPosition set the beginning and end of the search bounds and the direction of the search, but Start provides the ability to start finding text at a position other than BeginPosition.

The DocumentViewerFindTextStart enumeration allows the operation to start inside or after the selection bounds (which is useful when paired with SelectFirstResult) or to start at a unique position with ManualStartPosition.

Though Start may be a value other than BeginPosition, the search may still effectively run from BeginPosition to EndPosition if:

DocumentViewerFindTextStart.InSelection or DocumentViewerFindTextStart.AfterSelection is used and there is no selected text or the selected text is before the BeginPosition
DocumentViewerFindTextStart.ManualPosition is used and ManualStartPosition is null

Otherwise, Start is likely to cause two internal searches:

Search from the starting point to EndPosition.
If the starting point from (1) was not BeginPosition, and FindAll or Loop is true, search from BeginPosition to start – 1.

For more information, refer to DocumentViewerText.Find.

History