DocumentCacheOptions Enumeration

Summary

Determines which extra parts of the document will be stored in the cache.

Syntax

C++/CLI

Python

[SerializableAttribute()] 
[DataContractAttribute()] 
[FlagsAttribute()] 
public enum DocumentCacheOptions

public: 
   [SerializableAttribute,  
   DataContractAttribute,  
   FlagsAttribute] 
   enum class DocumentCacheOptions sealed

class DocumentCacheOptions(Enum): 
   None = 0 
   PageImage = 1 
   PageSvg = 2 
   PageSvgBackImage = 4 
   PageThumbnailImage = 8 
   PageText = 16 
   PageAnnotations = 32 
   All = 63

Members

Value	Member	Description
0x00000000	None	No extra parts of the document is cached. Only what is needed to re-construct the documents and its pages from the cache.
0x00000001	PageImage	Calls to DocumentPage.GetImage will try to save the result in the cache and re-used in subsequent calls.
0x00000002	PageSvg	Calls to DocumentPage.GetSvg will try to save the result in the cache and re-used in subsequent calls.
0x00000004	PageSvgBackImage	Calls to DocumentPage.GetSvgBackImage will try to save the result in the cache and re-used in subsequent calls.
0x00000008	PageThumbnailImage	Calls to DocumentPage.GetThumbnailImage will try to save the result in the cache and re-used in subsequent calls.
0x00000010	PageText	Calls to DocumentPage.GetText will try to save the result in the cache and re-used in subsequent calls.
0x00000020	PageAnnotations	Calls to DocumentPage.GetAnnotations will try to save the result in the cache and re-used in subsequent calls.
0x0000003F	All	All results are cached and re-used in subsequent calls.

Remarks

DocumentCacheOptions is used as the type of LoadDocumentOptions.CacheOptions and LEADDocument.CacheOptions to determine which extra parts of the document is in stored cached.

The value of DocumentCacheOptions.None (the default) means to store only the necessary data needed to re-construct the document and its pages from the cache (for example, when DocumentFactory.LoadFromCache is called.

Other values will try to store the results of getting the page images, SVGs, text, and annotations into the cache to speed up subsequent calls.

Requirements

Target Platforms

Reference

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies