DocumentId Property

Summary

Unique identifier of this document.

Syntax

C++

Java

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 Document 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.Document.Writer; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
using Leadtools.Document; 
using Leadtools.Caching; 
using Leadtools.Annotations.Engine; 
using Leadtools.Ocr; 
using Leadtools.Barcode; 
using Leadtools.Document.Converter; 
 
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(); 
   } 
 
   var loadFromCacheOptions = new LoadFromCacheOptions(); 
   loadFromCacheOptions.Cache = cache; 
   loadFromCacheOptions.DocumentId = documentId; 
   using (var document = DocumentFactory.LoadFromCache(loadFromCacheOptions)) 
   { 
      if (null != document) 
      { 
         document.AutoDeleteFromCache = true;//will be deleted 
      } 
   } 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Document.Writer 
Imports Leadtools.Svg 
Imports Leadtools.Document 
Imports Leadtools.Caching 
Imports Leadtools.Annotations.Engine 
Imports Leadtools.Barcode 
Imports Leadtools.Ocr 
Imports LeadtoolsDocumentExamples.LeadtoolsExamples.Common 
Imports Leadtools.Document.Converter 
 
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 LEADDocument = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Leadtools.pdf"), options) 
      document.AutoDeleteFromCache = False 
      documentId = document.DocumentId 
      document.SaveToCache() 
   End Using 
 
   Dim loadFromCacheOptions As New LoadFromCacheOptions 
   loadFromCacheOptions.Cache = cache 
   loadFromCacheOptions.DocumentId = documentId 
   Using document As LEADDocument = DocumentFactory.LoadFromCache(loadFromCacheOptions) 
      If document IsNot Nothing Then 
         'will be deleted 
         document.AutoDeleteFromCache = True 
      End If 
   End Using 
End Sub

Requirements

Target Platforms

Reference

LEADDocument Class

LEADDocument Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies