In This Topic ▼

load Method

Summary

Loads an annotation container from the specified xml data.

Syntax

TypeScript

JavaScript

AnnCodecs.prototype.load = function( 
   xmlData, 
   pageNumber 
)

load( 
   xmlData: string, 
   pageNumber: number 
): AnnContainer;

xmlData

A string containing the xml data of the annotations to be loaded. Must not be null.

pageNumber

1-based page number to load.

Remarks

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

If xmlData 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 returns 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

Help Version 20.0.2020.3.31

Leadtools.Annotations.Engine Assembly