autoDisposeDocument Property

Summary

Indicates whether to automatically dispose the existing object when a new document is set in the viewer.

Syntax

JavaScript Syntax

Object.defineProperty(DocumentViewer.prototype, 'autoDisposeDocument', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

autoDisposeDocument: boolean;

Property Value

true to automatically dispose the existing object when a new document is set in the viewer; otherwise, false. Default value is true.

Remarks

When the value of the AutoDisposeDocument is set to true, the document viewer will call the Document.Dispose method on the existing document if it exist before replacing it with the new object or when the document viewer itself is disposed. In other, when SetDocument is called, the ownership of the Document object is transferred to this DocumentViewer from the calling application. Document will be kept inside the viewer until it is no longer needed (when a new document is set, or when the viewer is no longer used).

The Document class holds resources that need to be returned to the system when it is no longer used.

Requirements

Target Platforms

Reference

DocumentViewer Class

DocumentViewer Members

Leadtools.Documents.UI Namespace

Help Version 19.0.2017.10.27