DocumentFactory Object

Summary

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

Syntax
TypeScript
JavaScript
function lt.Document.DocumentFactory 
class lt.Document.DocumentFactory() 

Remarks

The main class used for the LEADTOOLS Document class library is LEADDocument, which abstracts the internal implementation to provide unified properties and methods to access the internal document. Users can create 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 LEADDocument 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.
CheckCacheInfo
Retrieves information for a document in the cache.
BeginUpload, UploadDocument, UploadDocumentBlob, EndUpload and AbortUploadDocument Uploads raw data or JavaScript Blob a document in chunks to the cache system used by the service.
UploadFile/uploadfiledocument Uploads a JavaScript Blob/File object in one shot to the cache system used by the service.
DownloadDocumentData
Downloads the document data 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 20.0.2020.4.3
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly