←Select platform

DocumentId Property (Document)

Summary

Unique identifier of this document.

Syntax

Java

C++

public string DocumentId { get; }

Public ReadOnly Property DocumentId() As String 
   Get

public:  
   property String^ DocumentId 
   { 
      String^ get() 
   }

public String getDocumentId()

Property Value

The unique identifier of this document.

Remarks

This value is set by the framework when the document is initialized. The ID is important when using the document with the cache system and is the only value needed to re-construct completely the document from the cache. The current implementation of the Documents library will pass the document ID as the "regionName" value for all cache operations.

Example

This example will show how to use DocumentId to save a document to the cache and then reload it then delete it from the cache.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.DocumentWriters; 
using Leadtools.Svg; 
using Leadtools.Documents; 
using Leadtools.Caching; 
using Leadtools.Annotations.Core; 
using Leadtools.Forms.Ocr; 
using Leadtools.Barcode; 
 
       
public static void DocumentIdExample() 
{ 
   var cache = GetCache(); 
   var policy = new CacheItemPolicy(); 
   policy.AbsoluteExpiration = DateTime.Now + new TimeSpan(0, 0, 10); 
   policy.SlidingExpiration = new TimeSpan(0, 0, 10); 
 
   var options = new LoadDocumentOptions(); 
   options.Cache = cache; 
   options.CachePolicy = policy; 
 
   string documentId = null; 
 
   using (var document = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Leadtools.pdf"), options)) 
   { 
      document.AutoDeleteFromCache = false; 
      documentId = document.DocumentId; 
      document.SaveToCache(); 
   } 
 
   using (var document = DocumentFactory.LoadFromCache(cache, documentId)) 
   { 
      if (null != document) 
      { 
         document.AutoDeleteFromCache = true;//will be deleted 
      } 
   } 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Forms.DocumentWriters 
Imports Leadtools.Svg 
Imports Leadtools.Documents 
Imports Leadtools.Caching 
Imports Leadtools.Annotations.Core 
Imports Leadtools.Barcode 
Imports Leadtools.Forms.Ocr 
 
<TestMethod()> 
Public Shared Sub DocumentIdExample() 
   Dim cache As ObjectCache = GetCache() 
   Dim policy As CacheItemPolicy = New CacheItemPolicy() 
   policy.AbsoluteExpiration = DateTime.Now + New TimeSpan(0, 0, 10) 
   policy.SlidingExpiration = New TimeSpan(0, 0, 10) 
 
   Dim options As LoadDocumentOptions = New LoadDocumentOptions() 
   options.CachePolicy = policy 
   options.Cache = cache 
 
   Dim documentId As String = Nothing 
 
   Using document As Document = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Leadtools.pdf"), options) 
      document.AutoDeleteFromCache = False 
      documentId = document.DocumentId 
      document.SaveToCache() 
   End Using 
 
   Using document As Document = DocumentFactory.LoadFromCache(cache, documentId) 
      If document IsNot Nothing Then 
         'will be deleted 
         document.AutoDeleteFromCache = True 
      End If 
   End Using 
End Sub