DocumentFactory Class Members

Summary

The following tables list the members exposed by DocumentFactory.

Public Methods

Name Description
Public Method static  | Shared in VB abortUploadDocument Informs the cache to stop allowing uploads of the document to this uri.
Public Method static  | Shared in VB beginUpload Starts uploading a document to the cache.
Public Method static  | Shared in VB beginUploadDocument Starts uploading a document to the cache.
Public Method static  | Shared in VB buildUrlProxy Helper method to build the final URL with current proxy settings.
Public Method static  | Shared in VB cancelFromPrepareAjax Raises a prepareAjax event and returns whether the AJAX should be cancelled.
Public Method static  | Shared in VB checkCacheInfo Retrieves information for a document in the cache using its ID.
Public Method static  | Shared in VB create Creates a new, empty virtual document.
Public Method static  | Shared in VB deleteFromCache Deletes the specified Document from the cache.
Public Method static  | Shared in VB downloadDocumentData Downloads the document data from the cache.
Public Method static  | Shared in VB endUpload Finishes uploading a document to the cache.
Public Method static  | Shared in VB getLeadCacheData Helper method to get the data part from a LEAD cache URI.
Public Method static  | Shared in VB isLeadCacheScheme Helper method to determine whether a string value contains a valid LEAD cache URI.
Public Method static  | Shared in VB isUploadDocumentUri Indicates whether the URL points to a special LEAD cache scheme.
Public Method static  | Shared in VB loadDocumentAttachment Loads an attachment as a LEADDocument object.
Public Method static  | Shared in VB loadFromCache Retrieves the document matching the given documentId string from the cache.
Public Method static  | Shared in VB loadFromFile Loads a document from a Blob object.
Public Method static  | Shared in VB loadFromUri Loads a document from existing data stored in a remote URL.
Public Method static  | Shared in VB makeLeadCacheUri Constructs a LEAD cache URI from a document ID.
Public Method static  | Shared in VB saveAttachmentToCache Saves an attachment to the cache.
Public Method static  | Shared in VB saveToCache Saves the document to the cache.
Public Method static  | Shared in VB uploadDocument Uploads raw data to the cache.
Public Method static  | Shared in VB uploadDocumentBlob Uploads data in a JavaScript Blob/File to the cache.
Public Method static  | Shared in VB uploadFile Uploads a new document to the server in one shot.
Public Method static  | Shared in VB uploadFileDocument Uploads a new document with options to the server in one shot.
Public Method static  | Shared in VB verifyService Makes a parameter-less call to the Document Service to verify a proper connection and obtain service information.

Public Properties

Name Description
Public Property static  | Shared in VB localProxyUrlTemplate The path to the proxy api of the service used to load local documents.
Public Property static  | Shared in VB logErrors Indicates whether errors should be logged to the console.
Public Property static  | Shared in VB serviceApiPath The path to the api endpoints of the service.
Public Property static  | Shared in VB serviceHost The LEADTOOLS Document Service host location.
Public Property static  | Shared in VB servicePath The path from the host to the application root.
Public Property static  | Shared in VB serviceUri Gets the full URL of the service.
Public Property static  | Shared in VB serviceUserData User data to be passed to the service with the next Document Service call.
Public Property static  | Shared in VB uploadBlobChunkSize Maximum size of the chunk of data to use when uploading data to the service.

Public Events

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

See Also

DocumentFactory Class

Leadtools.Document Namespace

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

Leadtools.Document Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.