Back to Devexpress

DocumentStorage Class

corelibraries-devexpress-dot-xtraprinting-dot-caching-a7444666.md

latest3.7 KB
Original Source

DocumentStorage Class

A base class for storages used by the CachedReportSource and CachedReportSourceWeb objects to cache the document that they generate to display/export/print a report.

Namespace : DevExpress.XtraPrinting.Caching

Assembly : DevExpress.Printing.v25.2.Core.dll

NuGet Package : DevExpress.Printing.Core

Declaration

csharp
public abstract class DocumentStorage :
    IDisposable
vb
Public MustInherit Class DocumentStorage
    Implements IDisposable

The following members return DocumentStorage objects:

LibraryRelated API Members
Cross-Platform Class LibraryCachedReportSourceBase.Storage
.NET Reporting ToolsIDocumentStorageProvider.CreateNew(String)

Remarks

You can use one of the following ready-to-use document storages:

In any document storage type, different document parts are stored in different locations. A location is specified by the DocumentStorageLocation enumeration. Here are the possible locations:

Use the DocumentStorage class as a base class to implement a custom document storage. In your descendant, override the following members:

  • Count(DocumentStorageLocation location) method

  • Restore(DocumentStorageLocation location, int id) method

  • Store(DocumentStorageLocation table, int id, Stream stream) method

  • Clear() method

  • LastAccessTimeUtc property and UpdateLastAccessTime() method

A document storage is used in a multi-threaded mode. So, the custom document storage must be implemented using a thread safety concept.

Inheritance

Object DocumentStorage FileDocumentStorage

MemoryDocumentStorage

XpoDocumentStorage

DbDocumentStorage

See Also

DocumentStorage Members

DevExpress.XtraPrinting.Caching Namespace