←Select platform

Stream Property (Document)

Summary

Original document stream.

Syntax

Java

C++

public System.IO.Stream Stream { get; }

Public ReadOnly Property Stream() As System.IO.Stream 
   Get

public:  
   property System::IO::Stream^ Stream 
   { 
      System::IO::Stream^ get() 
   }

public InputStream getStream()

Property Value

Original document stream.

Remarks

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).

Example

For an example, refer to DocumentFactory.LoadFromStream.

Requirements

Target Platforms

See Also