In This Topic ▼

DocumentViewerText Class Members

Summary

The following tables list the members exposed by DocumentViewerText.

Public Methods

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

Public Properties

Name Description
Public Property autoGetText Indicates whether this DocumentViewerText should parse the text of the pages automatically when needed.
Public Property characterKeyModifier Modifier key to use to select individual characters in the page without their words or lines.
Public Property documentViewer Owner document viewer.
Public Property foundTextFill The fill used to highlight the results from previous calls to DocumentViewerText.Find.
Public Property hasAnySelectedText Indicates whether any pages in the document have selected text.
Public Property lastFindText The last DocumentViewerFindText options object used in a completed Find.
Public Property lineKeyModifier Modifier key to use for selecting the whole line when any of its characters is selected.
Public Property lineSelectionMode Controls how the viewer treats soft line breaks found in the text.
Public Property renderSelection Indicates whether selected text should be automatically rendered on the view.
Public Property selectedFill The fill color used to highlight the currently selected text.
Public Property selectedTextBegin The beginning position of any selected text in the document.
Public Property selectedTextEnd The ending position of any selected text in the document.
Public Property wordKeyModifier Modifier key to use for selecting the whole word when any of its characters is selected.

Help Version 20.0.2019.10.14
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document.Viewer Assembly