←Select platform

DocumentCacheInfo Class

Summary

Information about and properties of a document in the cache.

Syntax
C#
VB
C++
[SerializableAttribute()] 
[DataContractAttribute()] 
public class DocumentCacheInfo 
<SerializableAttribute(),  
 DataContractAttribute()>  
Public Class DocumentCacheInfo 
public: 
   [SerializableAttribute,  
   DataContractAttribute] 
   ref class DocumentCacheInfo 

Remarks

DocumentCacheInfo is returned by DocumentFactory.GetDocumentCacheInfo to quickly obtain information about a document in the cache without loading it. This includes whether the document is in the cache, its name and mime type, the number of pages, and whether it was loaded by the user.

This class contains the following members:

Member Description
DocumentId The unique ID of the document.
IsVirtual Indicates whether the document is virtual.
IsLoaded Indicates whether the document has been loaded at least once.
HasAnnotations Indicates whether the document has any annotations.
Name Document name
MimeType MIME type of the document
MimeTypeStatus Status of checking the document MIME type.
DocumentDataLength Length in bytes of the original document file, if any.
AnnotationsDataLength Length bytes of the original annotation file, if any.
PageCount Number of pages in this document.
HasUserToken Indicates that the document has an associated user token.
UserToken The user token associated with this document.

Example

For an example, refer to GetDocumentCacheInfo(ObjectCache,string).

Requirements

Target Platforms

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

Leadtools.Document Assembly