beginUpdate Method

Summary

Stops the viewer from updating its parts and rendering the content if the document changes.

Syntax

JavaScript Syntax

DocumentViewer.prototype.beginUpdate = function()

TypeScript Syntax

beginUpdate(): void;

Remarks

The BeginUpdate method will cause the viewer to not update its parts and rendering the content. This is useful to increase the control's speed efficiency when adding or removing more than one page from the Document. When the user calls the EndUpdate method, the viewer will then update the parts to show all the changes that have been made.

For better visual results and for speed efficiency, it is recommended you surround multiple calls that will result in pages being added or removed between BeginUpdate and EndUpdate.

Calls to BeginUpdate and EndUpdate are accumulative. Each call to BeginUpdate must be matched with a corresponding call to EndUpdate or else updates to the viewer will not be applied.

When the final EndUpdate is called and updating is resumed, the viewer will render the new content of the parts.

Requirements

Target Platforms

Reference

DocumentViewer Class

DocumentViewer Members

Leadtools.Documents.UI Namespace

Help Version 19.0.2017.10.27