hasAnyDocumentPageText Method (DocumentViewerText)

Summary

Indicates whether the text for all the pages have been obtained.

Syntax

JavaScript Syntax

DocumentViewerText.prototype.hasAnyDocumentPageText = function()

TypeScript Syntax

hasAnyDocumentPageText(): boolean;

Return Value

true if the text for all the pages have been obtained; otherwise, false.

Remarks

DocumentViewerText contains many operations that require the text of the page(s) being parsed. This is done by calling the DocumentPage.GetText method of the page.

DocumentPage.GetText parses the text from the page using SVG or OCR and that could be a slow operation. Hence, when it is called by DocumentViewerText, the resulting DocumentPageText object is stored internally and re-used when it is needed.

When the user sets a new Document in DocumentViewer using SetDocument, the saved DocumentPageText objects are discarded but the viewer will not start parsing the text for any pages until it is needed.

When all the text for all pages have been obtained, whether through the use of AutoGetText, GetDocumentPageText or GetAllDocumentPageText, then HasAnyDocumentPageText will return true and indicates that all text operations will be instant.

Requirements

Target Platforms

See Also