In This Topic ▼

getInfoFromXmlDocument Method

Summary

Gets information about the specified annotation xml document.

Syntax

TypeScript

JavaScript

AnnCodecs.prototype.getInfoFromXmlDocument = function( 
   document 
)

getInfoFromXmlDocument( 
   document: Document 
): AnnCodecsInfo;

document

XML document containing annotations data previously saved with Save. This value cannot be null.

An AnnCodecsInfo object that will be updated with information about the specified annotation file.

Remarks

If document contains valid LEADTOOLS annotations data, then this method will return an instance of AnnCodecsInfo containing the following:

Member	Description
Format	Set to AnnFormat.Annotations
Version	Set to the version of the LEADTOOLS Annotations file format. Currently, this will be 1.0
Pages	Set to an array of integer values containing the page numbers of the annotations containers found in the data.

If document does not contain valid LEADTOOLS annotations data, then this method will return instance of AnnCodecsInfo with Format set to AnnFormat.Unknown.

If document is null or does not contain valid XML data, then an exception will be thrown.

Requirements

Help Version 23.0.2024.3.4

Leadtools.Annotations.Engine Assembly