DocumentViewerText Class Members

Summary

The following tables list the members exposed by DocumentViewerText.

Public Methods

Name Description
clearLastFindText Clears the last find text operation results.
clearRenderedFoundText Clears the internal list of rendered results from previous calls to Find.
clearSelection Clears the text selection in the specified page or the whole document.
copy Copies the selected text to the clipboard
dispose Destroys this object and removes it from the page.
exportText Text of a page or the whole document as a simple string object.
find Searches the pages of a document to find matches to provided text options.
getAllDocumentPageText DocumentPageText objects for all the pages in the document.
getDocumentPageText DocumentPageText object of a page.
getPageTextItems Extract a DocumentViewerMultiLineTextItem between two positions.
getSelectedText Selected text of a page or all pages in the document as a simple string object.
getSelectedTextItems Selected text of a page as a list of DocumentViewerTextItem.
hasAnyDocumentPageText Indicates whether the text for all the pages have been obtained.
hasDocumentPageText Indicates whether the text for the specified page have been obtained.
hasSelectedText Checks whether the specified page or all pages in the document have text that is currently selected.
selectAll Selects all the text in the specified page or the whole document.
selectText Selects the text that intersect with a specified area.
setDocumentPageText Sets the text for a page.
setSelectedTextItems Replaces the selected text items for a page.

Public Properties

Name Description
autoGetText Indicates whether this DocumentViewerText should parse the text of the pages automatically when needed.
characterKeyModifier Modifier key to use to select individual characters in the page without their words or lines.
documentViewer Owner document viewer.
foundTextFill The fill used to highlight the results from previous calls to DocumentViewerText.Find.
hasAnySelectedText Indicates whether any pages in the document have selected text.
lastFindText The last DocumentViewerFindText options object used in a completed Find.
lineKeyModifier Modifier key to use for selecting the whole line when any of its characters is selected.
lineSelectionMode Controls how the viewer treats soft line breaks found in the text.
renderSelection Indicates whether selected text should be automatically rendered on the view.
selectedFill The fill used to highlight the currently selected text.
selectedTextBegin The beginning position of any selected text in the document.
selectedTextEnd The ending position of any selected text in the document.
wordKeyModifier Modifier key to use for selecting the whole word when any of its characters is selected.
Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Documents.UI Assembly