dispose Method

Summary

Disposes the data and elements used for the DocumentViewer.Print operation.

Syntax

JavaScript Syntax

DocumentPrintData.prototype.dispose = function()

TypeScript Syntax

dispose(): void;

Remarks

Dispose will clean up the data in DocumentPrintData and is called automatically when DocumentViewer.Print is called again (provided this DocumentPrintData used PrintDocumentOptions.AutoDispose).

Dispose loops through each of the DocumentPrintPageData in Pages and calls DocumentPrintPageData.Dispose, removes any styles in PrintStyles from their parent, and removes the Root from the document.

It is important to call Dispose before unloading the webpage to prevent memory leaks, particularly when using PrintDocumentOptions.UsePDFClientRendering, as these elements may make use of Blob URLs.

Dispose is also called for the most recently completed DocumentViewer.Print's DocumentPrintData when DocumentViewer.Dispose is called.

For more information, refer to DocumentViewer.Print.

History

19.0.0.48: Added

Requirements

Target Platforms

Reference

DocumentViewer Class

DocumentViewer Members

Leadtools.Documents.UI Namespace

Help Version 19.0.2017.10.27