DocumentFactory Object

Summary

Provides support for loading Document objects as well as managing the global settings used by the Documents library.

Syntax

JavaScript Syntax
function lt.Documents.DocumentFactory 
TypeScript Syntax
class lt.Documents.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 created a new document to load existing from memory, 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
LoadFromUri Loads a document from existing data stored in a remote URL
LoadFromCache Loads a previously saved document from the cache

In addition to the above, DocumentFactory contains the following functionality:

Member Description
Create Creates a new empty document
SaveToCache Saves a document to the cache.
DeleteFromCache Deletes a previously saved document from the cache
UploadFile, BeginUpload, UploadDocument and AbortUploadDocument Provides support for uploading a document to the cache system used by the factory
DownloadDocument Download any item from the cache.
PrepareAjax Event that occurs before any request is made by the factory to the server to allow the user to examine or modify the parameters passed.
Example

For an example, refer to LoadFromUri.

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