SaveToCache Method

Summary

Saves the document to the cache.

Syntax

C++

Java

public void SaveToCache()

Public Sub SaveToCache()

public:  
   void SaveToCache()

public void saveToCache()

Remarks

Documents can contain many pages and huge amounts of data. Storing all this data in the physical memory is not feasible in most situations. Therefore, the LEADDocument class was designed to use an external caching system to store the modified document. Refer to DocumentFactory.Cache for more information.

HasCache determines if this document is using the cache system. SaveToCache can be used to save a document to the cache and re-load it with DocumentFactory.LoadFromCache.

Set AutoDeleteFromCache to true if your application uses caching to speed up processing the document and the object will not be used after it is disposed.

Set AutoDeleteFromCache to false if your application will save the document ID before disposing the document, and use it to re-load the document by calling DocumentFactory.LoadFromCache.

To save the document to the cache, call SaveToCache or set the value of AutoSaveToCache to true before disposing the document.

The document is only saved into the cache if the value of CacheStatus is DocumentCacheStatus.NotSynced. When SaveToCache returns successfully, the value of CacheStatus of the document will be DocumentCacheStatus and will contain the timestamp of the operation.

Refer to Document Toolkit and Caching for more information.

Example

For an example, refer to DocumentId.

Requirements

Target Platforms