clearSelection Method

Summary

Clears the text selection in the specified page or the whole document.

Syntax

JavaScript Syntax

DocumentViewerText.prototype.clearSelection = function(pageNumber)

TypeScript Syntax

clearSelection(pageNumber: number): boolean;

Parameters

pageNumber

Page number to use. If this value is 0, then the text of all pages in the document will be used.

Return Value

true if any text selection state was cleared; otherwise, false.

Remarks

When this method returns, the new selected text (if any) can be obtained by GetSelectedTextItems (or GetSelectedText as a simple string).

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.

Requirements

Target Platforms

Reference

DocumentViewerText Class

DocumentViewerText Members

Leadtools.Documents.UI Namespace

Help Version 19.0.2017.10.27