getSelectedTextItems Method (DocumentViewerText)

Summary

Selected text of a page as a list of DocumentViewerTextItem.

Syntax

JavaScript Syntax

DocumentViewerText.prototype.getSelectedTextItems = function(pageNumber)

TypeScript Syntax

getSelectedTextItems(pageNumber: number): DocumentViewerTextItem[];

Parameters

pageNumber

Page number to use. This value cannot be 0.

Return Value

An array of the currently selected text items of the page, or null if the page does not have any selected text.

Remarks

DocumentViewerText stores the state of the current text selection internally. Use GetSelectedText to obtain the selected text as a simple string object and GetSelectedTextItems to obtain this value as an array of DocumentViewerTextItem that contains information on the character range of the selection in the corresponding DocumentPageText and the total boundary of the selection in document units.

When RenderSelection is true, DocumentViewerView calls GetSelectedTextItems to highlight the selected text on the ImageViewer object.

Requirements

Target Platforms

See Also

Reference

DocumentViewerText Class

DocumentViewerText Members

Leadtools.Documents.UI Namespace