In This Topic ▼

selectText Method

Summary

Selects the text that intersect with a specified area.

Syntax

TypeScript

JavaScript

DocumentViewerText.prototype.selectText = function( 
   area, 
   mode 
)

selectText( 
   area: LeadRectD, 
   mode: DocumentViewerSelectTextMode 
): void;

Parameters

area

location and size of the area to check. This is in pixels and must be in control (client) coordinates, such as directly

from a mouse event.

mode

Mode to use for the selection.

Remarks

This method selects text from all the pages that currently intersects with area. When this method returns, the new selected text (if any) can be obtained by GetSelectedTextItems (or GetSelectedText as a simple string).

clearSelection is an empty rectangle or if none of the text intersects with the rectangle.

This method fires Operation with DocumentViewerOperation.TextSelectionChanged and DocumentViewerOperation.PageTextSelectionChanged if the result of the operation changes the state of text selection.

If RenderSelection is true, then the selected text will be highlighted on the view ImageViewer object automatically.

If the text of any of the pages that is checked is not obtained yet, then the value of AutoGetText will be used to determine whether DocumentPage.GetText is called automatically. Therefore, this method might experience a delay while the text is parsed from the document in this mode.

Example

For an example, refer to DocumentViewerText.

Requirements

Target Platforms

Reference

DocumentViewerText Class

DocumentViewerText Members

Leadtools.Document.Viewer Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3