ShouldGetText Method

Summary

The callback function that is fired before the CompareView object attempts to get the text for a page.

Syntax
TypeScript
JavaScript
CompareView.prototype.shouldGetText = function( 
   page, 
   document 
) 
shouldGetText( 
   page: number, 
   document: LEADDocument 
): boolean; 

Parameters

page

Page number to get the text from

document

LEADDocument to get the text from

Return Value

A boolean indicating whether the CompareView should get the text for the page.

Remarks

The default value is null, meaning the CompareView object will always get the text for every page. Add a callback function here to have more fine-grained control over which pages the CompareView actually gets the text for.

Note: The CompareView object only tracks text that is retrieved by calling DocumentViewerText.getDocumentPageText. It will not track text that is called directly from the document via DocumentPage.getText.

Requirements

Target Platforms

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

Leadtools.Document.Viewer Assembly