autoDispose Property

Summary

Indicates whether to automatically dispose the internal data for this print operation the next time DocumentViewer.Print is called.

Syntax

JavaScript Syntax

Object.defineProperty(PrintDocumentOptions.prototype, 'autoDispose', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

autoDispose: boolean;

If true, the returned DocumentPrintData will be disposed on the next call to DocumentViewer.Print. The default value is true.

Remarks

After a DocumentViewer.Print operation completes, the DocumentPrintData is made available as the result of the JQuery Promise returned from DocumentViewer.Print. This data is also held internally. On a subsequent call to DocumentViewer.Print, this data will be disposed with an automatic call to DocumentPrintData.Dispose unless AutoDispose is false. If AutoDispose is false, it is highly recommended that DocumentPrintData.Dispose is called by the user after they have completed all work with the print data in order to prevent memory leaks.

For more information, refer to DocumentViewer.Print.

History

Requirements

Help Version 19.0.2017.10.27