←Select platform

LoadFromFile Method


Loads a document from existing data stored in a disk file.

public static LEADDocument LoadFromFile( 
   string fileName, 
   LoadDocumentOptions options 
Public Shared Function LoadFromFile( 
   ByVal fileName As String, 
   ByVal options As LoadDocumentOptions 
) As LEADDocument 
   static LEADDocument^ LoadFromFile( 
      String^ fileName, 
      LoadDocumentOptions^ options 
public static Document loadFromFile(String fileName, LoadDocumentOptions options) 



Path to the file name containing the original document data. This value cannot be null.


Options to use when loading the document. This value cannot be null.

Return Value

The newly created document object.


This method may use the cache if the related cache options are set. If the cache is used and neither the LoadDocumentOptions.Cache property nor the Cache property was set up with a valid cache object, this method will throw an exception.

LoadFromFile, LoadFromUri, LoadFromUriAsync and LoadFromStream creates a LEADDocument class from any supported image or document file format stored in a disk file, a remote URL, or a stream. The returned object can then be used to retrieve any page as an image or an SVG, obtain the text using SVG or OCR, or use the annotations or the document structure such as links and bookmarks.

After the document is obtained, the InternalObject property will be set to the internal LEADTOOLS object used with the document.

Refer to Load Using LEADTOOLS Document Library for detailed information on how to use this method and the various options.

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 DocumentFactoryLoadFromFileExample() 
   var options = new LoadDocumentOptions(); 
   using (var document = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Leadtools.pdf"), options)) 
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 DocumentFactoryLoadFromFileExample() 
   Dim options As New LoadDocumentOptions() 
   Using document As Leadtools.Document.LEADDocument = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Leadtools.pdf"), options) 
   End Using 
End Sub 


Target Platforms

Help Version 20.0.2020.4.3
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly