CachePolicy Property

Summary

The cache policy to use with the new document.

Syntax

C++/CLI

Java

Python

public CacheItemPolicy CachePolicy { get; set; }

public:  
   property CacheItemPolicy^ CachePolicy 
   { 
      CacheItemPolicy^ get() 
      void set(CacheItemPolicy^ value) 
   }

public CacheItemPolicy getCachePolicy() 
public void setCachePolicy(CacheItemPolicy value)

CachePolicy # get and set (LoadDocumentOptions)

Property Value

The cache policy to use for the new document that determine when the document and its parts are purged. Default value is a default CacheItemPolicy that never expires.

Remarks

CachePolicy is used when UseCache is set to true.

The policy must contain the desired absolute or sliding expiration date for the document and its part.

Using a cache policy does not mean the document will be stored in the cache forever, refer to AutoSaveToCache for more information on how the cache policy is used.

Refer to Loading Documents using Leadtools.Document for detailed information.

Example

Java

using Leadtools; 
using Leadtools.Caching; 
using Leadtools.Document; 
 
 
public void DocumentFactoryLoadFromFileExample() 
{ 
   var options = new LoadDocumentOptions(); 
   options.AnnotationsUri = null; 
   options.FirstPageNumber = 1; 
   options.LastPageNumber = -1; 
   options.Password = null; 
   options.WebClient = null; 
   options.CachePolicy = new CacheItemPolicy(); 
   using (var document = DocumentFactory.LoadFromFile(Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf"), options)) 
   { 
      PrintOutDocumentInfo(document); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.FileInputStream; 
import java.io.FileNotFoundException; 
import java.io.IOException; 
import java.io.InputStream; 
import java.net.URI; 
import java.net.URISyntaxException; 
import java.util.Calendar; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.caching.*; 
import leadtools.document.*; 
 
 
public void documentFactoryLoadFromFileExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   LoadDocumentOptions options = new LoadDocumentOptions(); 
   options.setAnnotationsUri(null); 
   options.setFirstPageNumber(1); 
   options.setLastPageNumber(-1); 
   options.setPassword(null); 
   options.setCachePolicy(new CacheItemPolicy()); 
   LEADDocument document = DocumentFactory.loadFromFile(combine(LEAD_VARS_IMAGES_DIR, "Leadtools.pdf"), options); 
   printOutDocumentInfo(document); 
   assertTrue(document != null); 
   System.out.println("Document created successfully"); 
   document.dispose(); 
}

or DocumentFactory.LoadFromUri.

Requirements

Target Platforms

Reference

LoadDocumentOptions Class

LoadDocumentOptions Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29