renderResults Property

Summary

Indicates whether to add the results of this Find Text operation to the list of rendered Find Text results.

Syntax

JavaScript Syntax

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

TypeScript Syntax

renderResults: boolean;

true to render the results of the Find Text operation into the DocumentViewer.View; otherwise false. The default value is true.

Remarks

If RenderResults is true, the results of DocumentViewerText.Find will be rendered on the page, as well the results of any previous DocumentViewerText.Find call since the last time DocumentViewerText.ClearRenderedFoundText was called. This allows multiple separate Find Text operations to highlight different areas of the document, or to achieve more detailed control over search areas by combining the results of several searches with different values for BeginPosition and EndPosition.

In most cases, it is useful to call DocumentViewerText.ClearRenderedFoundText before each call to DocumentViewerText.Find. The fill of the found text can be controlled from DocumentViewerText.FoundTextFill.

The first result (in order) can also be selected with SelectFirstResult. To control whether a single match or all matches are returned, use FindAll.

For more information, refer to DocumentViewerText.Find.

History

Example

For an example, refer to DocumentViewerText.Find.

Requirements

Help Version 19.0.2017.10.27