In This Topic ▼

getPageTextItems Method

Summary

Extracts a DocumentViewerMultiLineTextItem between two positions.

Syntax

TypeScript

JavaScript

DocumentViewerText.prototype.getPageTextItems = function( 
   begin, 
   end 
)

getPageTextItems( 
   begin: DocumentViewerTextPosition, 
   end: DocumentViewerTextPosition 
): DocumentViewerMultiLineTextItem;

begin

A DocumentViewerTextPosition indicating the beginning of the range. Should not be null. Must include a valid page number.

end

A DocumentViewerTextPosition indicating the end of the range. Should not be null. Must include a valid page number.

A DocumentViewerMultiLineTextItem encompassing the range between the two parameter positions.

Remarks

GetPageTextItems takes a starting and ending DocumentViewerTextPosition and returns a list of DocumentViewerTextItem within a DocumentViewerMultiLineTextItem. This return value can be supplied later to SetSelectedTextItems or to ImageViewer.EnsureBoundsVisible.

If null is passed for either parameter, null is returned immediately. The method will check for valid page numbers in the Document, and then continue. The result is then guaranteed to be a DocumentViewerMultiLineTextItem, but DocumentViewerMultiLineTextItem.TextItems will be null if no DocumentViewerTextItem are found between the positions.

Each page between (and including) the given DocumentViewerTextPosition.PageNumber of begin and end is checked. If the DocumentViewerTextPosition.PageNumber of begin is greater than that of end, no DocumentViewerTextItem instances will be added to DocumentViewerMultiLineTextItem.TextItems. In other words, parameters are expected to be in order.

If the checked DocumentPageText is null or has no text, it is skipped.

History

Requirements

Help Version 23.0.2024.2.29