←Select platform

DocumentFactory Class

Summary

Provide supports to load and create Document objects as well as managing the global cache.

Syntax

C#
VB
Java
C++
public static class DocumentFactory 
Public NotInheritable Class DocumentFactory 
public ref class DocumentFactory sealed abstract 
public final class DocumentFactory 

Remarks

The main class used for the LEADTOOLS Documents class library is Document. This class abstracts the internal implementation to provide unified properties and methods to access the internal document. Users can create a new document or load existing documents from disk file or a URL.

Documents cannot be created directly, instead, use the static DocumentFactory methods to obtain a Document instance as follows:

Member Description
LoadFromFile Loads a document from existing data stored in a disk file
LoadFromUri Loads a document from existing data stored in a remote URL
LoadFromUriAsync Loads a document asynchronously from an existing data stored in remote URL
LoadFromStream Loads a document from existing data stored in a stream
RasterCodecsTemplate Global template used when loading and saving raster and SVG images

When combined with ObjectCache provide the following extra functionality:

Member Description
Cache The global LEADTOOLS ObjectCache object responsible for managing cache items and expiration policies. The cache can be stored in this value (if the system requires the use of a single global cache) or a new instance is passed directly to the various uploading, loading and saving methods to use distinct or shared caches with each document.
Create Creates a new empty document
LoadFromCache Loads a previously saved document from the cache
DeleteFromCache Deletes a document from the cache
BeginUpload, UploadDocument and AbortUploadDocument Provides support for uploading a document to the cache system used by the factory
Example

C#
VB
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.DocumentWriters; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
using Leadtools.Documents; 
using Leadtools.Caching; 
using Leadtools.Annotations.Core; 
using Leadtools.Forms.Ocr; 
using Leadtools.Barcode; 
 
public static void DocumentFactoryExample() 
{ 
   var options = new LoadDocumentOptions(); 
   using (var document = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Leadtools.pdf"), options)) 
   { 
      PrintOutDocumentInfo(document); 
   } 
} 
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 
Imports LeadtoolsDocumentsExamples.LeadtoolsExamples.Common 
'Imports LeadtoolsDocumentsExamples.LeadtoolsExamples.Common 
 
Public Sub DocumentFactoryExample() 
   Dim options As New LoadDocumentOptions() 
   Using document As Leadtools.Documents.Document = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Leadtools.pdf"), options) 
      PrintOutDocumentInfo(document) 
   End Using 
End Sub 

Requirements

Target Platforms

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Documents Assembly