In This Topic ▼

CompareView Constructor

Summary

Initializes a new instance of this class.

Syntax

TypeScript

JavaScript

CompareView = function( 
   viewers 
)

constructor( 
   viewers: DocumentViewer[] 
);

viewers

Remarks

Exactly two DocumentViewers must be provided. The Document.Viewer at position 0 will be designated the original viewer – Delete DifferenceOperations will be painted to this viewer. The Document.Viewer at position 1 will be designated the modified viewer – Insert DifferenceOperations will be painted to this viewer.

When a CompareView object is instantiated, it will perform the following tasks:

Specifically, the CompareView object will listen to the following functions:

DocumentViewerOperation.SetDocument
- If isPostOperation is false, the internal cache entries for the old document will be cleared. Any compare information will also be purged; differences, selectedDeletion, and selectedInsertion will be set to null. Any pending compare operations will be canceled as well.
- If isPostOperation is true, internal comparison operations will resume.
DocumentViewerOperation.GetPage and DocumentViewerOperation.RenderViewPage
- Whenever a page is fetched, the CompareView will silently reach out and call DocumentPage.getText. When the getText call returns, the text data will be pushed into the internal cache.

Requirements

Help Version 20.0.2020.4.3