LoadFromCache(String) Method

public static Document LoadFromCache( 
   string documentId
)

'Declaration
 

Public Overloads Shared Function LoadFromCache( _
   ByVal documentId As String _
) As Document

'Usage
 

Dim documentId As String
Dim value As Document
 
value = DocumentFactory.LoadFromCache(documentId)

public static Document loadFromCache(String documentId)
            

public:
static Document^ LoadFromCache( 
   String^ documentId
) 

Parameters

documentId

The document identifier. This value cannot be null.

Return Value

This method is the equivalant of calling LoadFromCache(DocumentFactory.Cache, documentId) and therefore will throw an exception if Cache was not setup.

Use this method to load a document previously stored in the cache with SaveToCache. The document will be re-loaded and populated exactly as it was during the time it was saved. If the document was originally created by using LoadFromFile then the original file must still exist and can be accessed. If the document was originally created by using LoadFromUri, LoadFromUriAsync or Create, then the library had copied the original file into the cache and is no longer used. The document can be re-constructed even if the original file is deleted. If this document was originally created by using LoadFromStream, then the data stored in the stream was saved into the cache during SaveToCache and the stream is no longer used and loading this document will act in the same manner as if it was downloaded from an external URI.

This method may return null if the document was in the cache but is expired and purged.

Saving and loading from the cache is useful if the document is to be re-used between sessions in your application. The document identifier (documentId) is all you need to store to re-construct the document after it was saved to the cache and disposed. This ID can be stored in a database or passed to the client side as in the case of the LEADTOOLS Documents Web Service.

For an example, refer to DocumentId.

Target Platforms

Reference

DocumentFactory Class
DocumentFactory Members
Overload List