In This Topic ▼

DocumentFactory Class Members

Summary

The following tables list the members exposed by DocumentFactory.

Public Methods

Name Description
Public Method abortUploadDocument Informs the cache to stop allowing uploads of the document to this uri.
Public Method beginUpload Starts uploading a document to the cache.
Public Method beginUploadDocument Starts uploading a document to the cache.
Public Method cancelFromPrepareAjax Raises a prepareAjax event and returns whether the AJAX should be cancelled.
Public Method checkCacheInfo Retrieves information for a document in the cache using its ID.
Public Method create Creates a new empty virtual document.
Public Method deleteFromCache Deletes the specified Document from the cache.
Public Method downloadDocumentData Downloads the document data from the cache.
Public Method endUpload Finishes uploading a document to the cache.
Public Method isUploadDocumentUri Gets a value that indicate whether the URL points to a special LEAD cache scheme.
Public Method loadFromCache Retrieves the document matching the given documentId string from the cache.
Public Method loadFromFile Loads a document from a File object.
Public Method loadFromUri Loads a document from existing data stored in a remote URL.
Public Method saveToCache Saves the document to the cache.
Public Method uploadDocument Uploads the specified data to the cache.
Public Method uploadFile Uploads a new document to the server.
Public Method verifyService Makes a parameter-less call to the Document Service to verify a proper connection.

Public Properties

Name Description
Public Property localProxyUrlTemplate The path to the proxy api of the service used to load local documents.
Public Property logErrors Indicate whether errors should be logged to the console.
Public Property serviceApiPath The path to the api endpoints of the service.
Public Property serviceHost The LEADTOOLS Document Service host location.
Public Property servicePath The path from the host to the application root.
Public Property serviceUri Gets the full URL of the service.
Public Property serviceUserData User data to be passed to the service with the next Document Service call.

Public Events

Name Description
Public Event prepareAjax Event that occurs before any AJAX request is made to the server to allow the user to examine or modify the parameters passed.

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

Leadtools.Document Assembly