Load(Stream,int,double,double) Method

Summary

Loads an annotation container from the specified stream with the specified resolution (for annotation files saved with LEADTOOLS prior to version 15).

Syntax

C++

Java

public AnnContainer Load( 
   Stream stream, 
   int pageNumber, 
   double dpiX, 
   double dpiY 
)

Public Overloads Function Load( _ 
   ByVal stream As Stream, _ 
   ByVal pageNumber As Integer, _ 
   ByVal dpiX As Double, _ 
   ByVal dpiY As Double _ 
) As AnnContainer

public AnnContainer load(InputStream is, int pageNumber)

public:  
   AnnContainer^ Load( 
      Stream^ stream, 
      Int32 pageNumber, 
      double dpiX, 
      double dpiY 
   )

Parameters

stream
Stream containing the XML data of the annotations to be loaded. This value must not be null.

pageNumber
1-based page number to load.

dpiX
The horizontal resolution of the image.

dpiY
The vertical resolution of the image.

Return Value

A new AnnContainer object containing all the objects loaded from stream.

Remarks

This method is designed to load annotation files that were saved with LEADTOOLS SDK prior to version 15. These files did not save the resolution of the image and the user has to manually pass these values before loading. Pass the original resolution used when the annotation file was created to dpiX and dpiY.

This method can only load annotations previously saved with the AnnFormat.Annotations format.

If stream contains a container with the same page as pageNumber, then this page will be loaded. If the value of pageNumber is 0, the first page is loaded. Otherwise, this method will return null.

The DeserializeOptions property can contain optional options and events to use during loading of annotations data.

For more information, refer to Annotation Files.

Example

For an example, refer to AnnCodecs

Requirements

Target Platforms