DocumentDataType Enumeration

Summary

Data type of a LEADDocument.

Syntax

C++/CLI

Python

[SerializableAttribute()] 
[DataContractAttribute()] 
public enum DocumentDataType

public: 
   [SerializableAttribute,  
   DataContractAttribute] 
   enum class DocumentDataType sealed

class DocumentDataType(Enum): 
   Transient = 0 
   Cached = 1 
   Virtual = 2

Members

Value	Member	Description
0	Transient	The document has been created but has not been saved to the cache yet.
1	Cached	The document data is saved in the cache.
2	Virtual	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.

When a document is first created or loaded but is not saved in the cache, the data type will be set to Transient.

When a document is saved in the cache, the data type will be set to Cached.

When this is a virtual document containing other child documents, the data type will be set to Virtual.

Requirements

Target Platforms