UseCache Property (original) (raw)

Summary

Indicates whether the new document will use the cache system.

Syntax

public bool UseCache {get; set;} 

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

public boolean getUseCache() public void setUseCache(boolean value)

Property Value

true if the new document will use the cache system; otherwise, false. Default value is false.

Remarks

When the value of UseCache is true, then the factory will use the cache stored in one of the following locations:

1. First, the object set in LoadDocumentOptions.Cache. If this value is not null, then it will be used. This allows the use of different cache objects for each document, if required.
2. If the previous member did not have a valid value, then the global object set in DocumentFactory.Cache is checked. If this value is not null, it will be used.

In either case, ObjectCache must be set up with a valid LEADTOOLS cache object. The policy to use with this new document to determine when to purge the cache items must be set in CachePolicy. Refer to Loading Documents using Leadtools.Document for detailed information.