DocumentDocuments Object

Summary

Represents a collection of Document objects.

Syntax

JavaScript Syntax
function lt.Documents.DocumentDocuments 
	extends lt.LeadCollection 
TypeScript Syntax
class lt.Documents.DocumentDocuments() 
	extends lt.LeadCollection 

Remarks

DocumentDocuments manages the children of the document. It can be accessed through the Documents property of Document.

DocumentDocuments derives from LeadCollection. You can use any of the collection methods to iterate through the documents. This collection is read-only however and you cannot add, remove or change the items. Instead, use Pages to add or remove pages that belong to a separate document to this one. The Document.Documents collection will automatically gets updated to reflect what child documents are currently held in the document.

Here is an example that shows what happens to Document.Documents when pages are added and removed:

  1. When document (virtualDocument is created, Document.Documents is an empty collection

  2. The user creates a new empty page using CreatePage of virtualDocument and then adds it to the Document.Pages collection. The Document.Documents collection will still be an empty collection since the page original owner is the same document (in other words, DocumentPage.Document is virtualDocument

  3. The user add a page from another document (document1) into Document.Pages of virtualDocument. The Document.Documents collection will contain a single item: document1

  4. The user add another page from document1 into Document.Pages of virtualDocument. The Document.Documents collection will still contain the single item document1 since both pages has the same owner

  5. The user add a page from document2 into Document.Pages of virtualDocument. The Document.Documents collection will contain two items document1 and document2

  6. The user removes this last page from virtualDocument. The Document.Documents collection will be containing the single item document1

  7. The user removes all the pages from virtualDocument. The Document.Documents collection will be to being empty

When DocumentFactory.SaveToCache is called, the document will store the IDs of all the child documents.

When DocumentFactory.LoadFromCache is called, the document will try to re-load all the child documents and automatically set them in this collection. If any document fails to load or is no longer available in the cache, then all its pages are removed automatically and are nor loaded.

When the document is disposed, the value of AutoDisposeDocuments is examined, and if its true, then all the child documents are disposed as well.

Example

For an example, refer to DocumentFactory.Create.

Requirements

Target Platforms

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Documents Assembly