DocumentId Property

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 ExternalAttachmentsExample() 
   ' The cache we are using 
   Dim cache As New FileCache() 
   cache.PolicySerializationMode = CacheSerializationMode.Json 
   cache.DataSerializationMode = CacheSerializationMode.Json 
   cache.CacheDirectory = "c:\cache-dir" 
 
   ' The main document is a PDF 
   Dim mainDocumentFile As String = "C:\LEADTOOLS21\Resources\Images\leadtools.pdf" 
 
   ' Attachments we will be adding: a TIF, another PDF, and a JPG file 
   Dim attachmentFiles() As String = 
   { 
      "C:\LEADTOOLS21\Resources\Images\ocr1.tif", 
      "C:\LEADTOOLS21\Resources\Images\employee benefits survey.pdf", 
      "C:\LEADTOOLS21\Resources\Images\cannon.jpg" 
   } 
 
   ' Load the main document 
   Dim mainDocumentId As String 
   Dim loadDocumentOptions As New LoadDocumentOptions() 
   loadDocumentOptions.Cache = cache 
   Using mainDocument As LEADDocument = DocumentFactory.LoadFromFile(mainDocumentFile, loadDocumentOptions) 
      ' Save the document ID so we can load it from cache later 
      mainDocumentId = mainDocument.DocumentId 
 
      ' Show this document, it should have no attachments at this point 
      ShowDocumentWithAttachments("Initial", mainDocument, 0) 
 
      mainDocument.IsReadOnly = False 
      ' Now, load each attachment document and add it to the main document 
      For Each attachmentFile As String In attachmentFiles 
         Dim attachmentNumber As Integer = 1 
         Using attachmentDocument As LEADDocument = DocumentFactory.LoadFromFile(attachmentFile, loadDocumentOptions) 
            ' Save this document to the cache 
            attachmentDocument.AutoDeleteFromCache = False 
            attachmentDocument.SaveToCache() 
 
            ' Add it to the main document as an attachment 
            Dim attachment As New DocumentAttachment() 
            ' The attachment number. 
            attachment.AttachmentNumber = attachmentNumber 
            ' This Is an external attachment 
            attachment.IsEmbedded = False 
            ' And the document ID 
            attachment.DocumentId = attachmentDocument.DocumentId 
 
            ' The rest of the properties are optional but setting them might be helpful to an application user interface 
            attachment.FileName = attachmentDocument.Name 
            attachment.DisplayName = attachmentDocument.Name 
            attachment.FileLength = attachmentDocument.FileLength 
            attachment.MimeType = attachmentDocument.MimeType 
 
            mainDocument.Attachments.Add(attachment) 
            attachmentNumber = attachmentNumber + 1 
         End Using 
      Next 
      mainDocument.IsReadOnly = True 
 
      ' Now, show the document info again, it should have 3 attachments 
      ShowDocumentWithAttachments("After adding attachments", mainDocument, attachmentFiles.Length) 
 
      ' Ensure that attachments will be deleted when the owner document Is removed 
      mainDocument.AutoDeleteAttachmentsFromCache = True 
      ' Save this document to the cache 
      mainDocument.AutoDeleteFromCache = False 
      mainDocument.SaveToCache() 
   End Using 
 
   ' Re-load the main document from the cache 
   Dim loadFromCacheOptions As New LoadFromCacheOptions() 
   loadFromCacheOptions.Cache = cache 
   loadFromCacheOptions.DocumentId = mainDocumentId 
   Using mainDocument As LEADDocument = DocumentFactory.LoadFromCache(loadFromCacheOptions) 
      ' Show this document, it should have the attachments we saved 
      ShowDocumentWithAttachments("Loaded from cache", mainDocument, attachmentFiles.Length) 
   End Using 
 
   ' Another way of loading this attachment Is with DocumentFactory.LoadDocumentAttachment using the attachment number. 
   ' This method can be used to load both external And embedded attachments using the owner document ID And the attachment number. 
   Console.WriteLine("Using LoadDocumentAttachments:") 
   For attachmentNumber As Integer = 1 To attachmentFiles.Length 
      ' For loading the main document 
      loadFromCacheOptions = New LoadFromCacheOptions() 
      loadFromCacheOptions.Cache = cache 
      loadFromCacheOptions.DocumentId = mainDocumentId 
 
      ' For loading the attachment 
      Dim loadAttachmentOptions As New LoadAttachmentOptions() 
      loadAttachmentOptions.AttachmentNumber = attachmentNumber 
 
      Using attachmentDocument As LEADDocument = DocumentFactory.LoadDocumentAttachment(loadFromCacheOptions, loadAttachmentOptions) 
         Console.WriteLine("  " + GetDocumentInfo(attachmentDocument)) 
      End Using 
   Next 
 
   ' Clean up by deleting the original document from the cache. This will cause all attachment documents to be deleted as well 
   ' Since we set AutoDeleteAttachmentsFromCache to true earlier 
   loadFromCacheOptions = New LoadFromCacheOptions() 
   loadFromCacheOptions.Cache = cache 
   loadFromCacheOptions.DocumentId = mainDocumentId 
   DocumentFactory.DeleteFromCache(loadFromCacheOptions) 
End Sub 
 
Private Shared Sub ShowDocumentWithAttachments(message As String, document As LEADDocument, attachmentCount As Integer) 
   ' Show info about this document And any attachments 
   Console.WriteLine(message) 
   Console.WriteLine("  " + GetDocumentInfo(document)) 
 
   ' Sanity check 
   Debug.Assert(attachmentCount = document.Attachments.Count) 
 
   If document.Attachments.Count > 0 Then 
      Console.WriteLine("    Attachments:") 
 
      ' Show the attachments 
      For Each attachment As DocumentAttachment In document.Attachments 
         ' Load the attachment as a LEADDocument using the document ID 
         ' This method works for external attachments only 
         Dim loadFromCacheOptions As New LoadFromCacheOptions() 
         loadFromCacheOptions.Cache = document.GetCache() 
         loadFromCacheOptions.DocumentId = attachment.DocumentId 
         Using attachmentDocument As LEADDocument = DocumentFactory.LoadFromCache(loadFromCacheOptions) 
            Console.WriteLine("      " + GetDocumentInfo(attachmentDocument)) 
         End Using 
      Next 
   End If 
End Sub 
 
Private Shared Function GetDocumentInfo(document As LEADDocument) As String 
   Return $"DocumentId:{document.DocumentId} MimeType:{document.MimeType} Pages:{document.Pages.Count} Attachments:{document.Attachments.Count}" 
End Function 
 
Public Shared Function GetCache() As ObjectCache 
   ' Create a LEADTOOLS FileCache object 
 
   Dim cacheDir As String = Path.Combine(ImagesPath.Path, "cache") 
   If Directory.Exists(cacheDir) Then 
      Directory.Delete(cacheDir, True) 
   End If 
 
   Directory.CreateDirectory(cacheDir) 
 
   Dim cache As New FileCache() 
   cache.CacheDirectory = cacheDir 
 
   Return cache 
End Function