←Select platform

AutoSaveToCache Property (Document)

Summary

Indicates whether to automatically save the document to the cache before it is disposed.

Syntax

Java

C++

public bool AutoSaveToCache { get; set; }

Public Property AutoSaveToCache() As Boolean 
   Get 
   Set

public:  
   property bool AutoSaveToCache 
   { 
      bool get() 
      void set(bool value) 
   }

public boolean getAutoSaveToCache() 
public void setAutoSaveToCache(boolean value)

Property Value

true to automatically save the document to the cache before it is disposed, otherwise; false. Default value is false.

Remarks

Documents can contain large number of pages and huge amount of data. Storing all this data in the physical memory is not feasible in most situations. Therefore, the Document class was designed to use an external caching system to store the modified. 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-loading it using DocumentFactory.LoadFromCache.

Set AutoDeleteFromCache to true if your application uses cache 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 using DocumentFactory.LoadFromCache.

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

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

Requirements

Target Platforms

See Also