DownloadDocumentOptions Class

Summary

Options to use when downloading a document.

Syntax

C++

[SerializableAttribute()] 
[DataContractAttribute()] 
public class DownloadDocumentOptions

<SerializableAttribute(),  
 DataContractAttribute()>  
Public Class DownloadDocumentOptions

public: 
   [SerializableAttribute,  
   DataContractAttribute] 
   ref class DownloadDocumentOptions

Remarks

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:

Member	Description
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.

Example

For an example, refer to DocumentFactory.DownloadDocument.

Requirements

Target Platforms