autoEnsureVisible Property

Summary

Indicates whether the view should automatically pan so the found text is visible.

Syntax

JavaScript Syntax

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

TypeScript Syntax

autoEnsureVisible: boolean;

true if the view should automatically pan so the found text is visible; otherwise, false. Default value is true.

Remarks

(This property was removed in version 19.0.0.49. Please see SelectFirstResult instead.)

When used with DocumentViewerText.Find, the document viewer will automatically call ImageViewer.EnsureBoundsVisible on the location and size of the new text found (if any) to ensure it is visible in the current view.

The selected text is automatically rendered on the DocumentViewer.View if the value of DocumentViewerText.RenderSelection is true (the default).

History

Requirements

Help Version 19.0.2017.10.27