GetAnnotationsStream Method

Summary

Stream containing the data of the original annotations.

Syntax

C++/CLI

Java

Python

public Stream GetAnnotationsStream()

public:  
   System::IO::Stream^ GetAnnotationsStream()

public InputStream getAnnotationsStream()

def GetAnnotationsStream(self):

Return Value

Stream containing the data of the original annotations.

Remarks

The stream returned from this method is the same used by the various parts of the object when loading the pages and should not be disposed by the user. To ensure thread safety, always use the LockStreams before trying to use the stream and UnlockStreams when done to coordinate the use of this stream between user application and the document object.

Use HasAnnotationsStream to detect whether the document has a valid annotations stream.

The document can be loaded with the annotations stored into an external file. This is done through passing the URL to the location of the annotations in the LoadDocumentOptions.AnnotationsUri.

When the DocumentFactory is loading the documents and this value is not null, then depending on the type of the URI, it can be used as is (if the URL has a file scheme) or downloaded to the cache or a temp file (if the URL has any other scheme). and GetAnnotationsFileName can be used to get the path to this file.

If the cache object used do not support direct disk access (external resource), then the annotations data are stored in the cache and can be accessed at any time using GetAnnotationsStream.

For more information, refer to Loading Using LEADTOOLS Document Library.

Requirements

Target Platforms