In This Topic ▼

DocumentDataType Enumeration

Summary

Syntax

TypeScript

JavaScript

lt.Document.DocumentDataType = { 
   transient: 0, 
   cached: 1, 
   virtual: 2 
}

lt.Document.DocumentDataType = { 
   transient: 0, 
   cached: 1, 
   virtual: 2 
}

Members

Value	Member	Description
transient	0	The document is created but has not been saved to the cache yet.
cached	1	The document data is saved in the cache.
virtual	2	The document is virtual.

Remarks

DocumentDataType is used as the type of LEADDocument.dataType and DocumentPage.dataType properties to determine where the actual original data of the document or page is stored. DocumentViewer uses this value to optimize rendering and not incur unnecessary cache hits.

There are 3 scenarios to consider:

When a document is first created or loaded but is not saved in the cache, the data type will be set to DocumentDataType.transient.
If a document is saved in the cache, then the data type will be set to DocumentDataType.cached.
For a virtual document containing other child documents, the data type will be set to DocumentDataType.virtual.

Requirements

Target Platforms