autoDisposeDocuments Property (Document)

Summary

Indicates whether to automatically dispose any child documents.

Syntax

JavaScript Syntax

Object.defineProperty(Document.prototype, 'autoDisposeDocuments', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

autoDisposeDocuments: boolean;

Property Value

true to automatically dispose any child documents when this document is disposed, otherwise; false. Default value is false.

Remarks

When the value of AutoDisposeDocuments is true, then all the child documents will be automatically disposed when the owner document is disposed. Setting AutoDisposeDocuments to true is useful when loading the owner virtual document from the cache, performing some operation on it (for example putting it for display in the document viewer) and then disposing it. In other words, treating the document and its children as a single unit. Dispose will clear the memory used by any child document as well.

Setting AutoDisposeDocuments to false is useful when creating virtual documents on the fly, performing some operation on it (for example putting it for display in the document viewer) and then disposing it but keeping the child documents for other purposes, for instance, to create other virtual documents. In other words, treating the virtual document and as an independent unit from its children.

Note that calling Dispose on a document with AutoDisposeDocuments set to true will call Dispose on each child document and trigger the same action performed by the other related properties.

Note that setting this property to a value will update the same value in each child document.

Requirements

Target Platforms

See Also