Stream Property

public Stream Stream {get;}

'Declaration
 

Public ReadOnly Property Stream As Stream

'Usage
 

Dim instance As Document
Dim value As Stream
 
value = instance.Stream

public InputStream getStream()
            

public:
property Stream^ Stream {
   Stream^ get();
}

Property Value

Stream contains the original value passed to DocumentFactory.LoadFromStream otherwise the value will be null.

The Document class will use the stream members to read the various parts such as the images and metadata on demand as needed. It is the user responsibility to keep the stream alive while the document is not disposed. When the document is disposed, the stream is no longer used and can be closed or disposed by the user.

If the document is saved into the cache using SaveToCache, then the entire content of the stream is saved into the cache and the stream is no longer used and can be safely disposed by the user. When the document is later re-loaded from the cache using DocumentFactory.LoadFromCache, then it is treated as it was downloaded from an external resource and the stream functionality is not used (the value of Stream will be null).

For an example, refer to DocumentFactory.LoadFromStream.

Target Platforms

Reference

Document Class
Document Members