Options to use when downloading a document.
public class DownloadDocumentOptions
Public Class DownloadDocumentOptions
ref class DownloadDocumentOptions
DocumentFactory.DownloadDocument is used to download the data of a document stored in the cache, either all at one time, or in chunks. This method takes an instance of DownloadDocumentOptions as a parameter, indicating the document properties and download options as follows:
|Cache||The cache containing the document to download. This value must not be null|
|DocumentId||ID of the document to download. This value must not be null|
|Offset||0-based byte offset into the source data at which to begin reading the data|
|Length||Maximum number of bytes to read during this download operation. If this value -1, then reading is performed until the data end is reached|
|Data or Stream||Target to where store the document data into|
|DataOffset||Only Data is used to indicate where in the buffer storing starts|
DocumentFactory.DownloadAnnotations is used to download the annotations associated with a document. This method also takes an instance of DownloadDocumentOptions where the source data refers to the annotation instead of the document data.
For an example, refer to DocumentFactory.DownloadDocument.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries