GetInfoFromXmlDocument Method (original) (raw)

Summary

Gets information about the specified XML document.

Syntax

- (LTAnnCodecsInfo *)getInfoFromXmlDocument:(DDXMLDocument *)document NS_SWIFT_NAME(getInfo(from:)); 

Parameters

document
Document containing the annotation data. This value cannot be null.

Return Value

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

Remarks

If _document_ contains valid LEADTOOLS annotation data, then this method will return an AnnCodecsInfo object 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 an AnnCodecsInfo object with Format set to AnnFormat.Unknown.

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

Leadtools.Annotations.Engine Assembly