In This Topic ▼

getAnnotations Method

Summary

Gets an array of annotations container objects for all pages with a single call.

Syntax

TypeScript

JavaScript

DocumentAnnotations.prototype.getAnnotations = function( 
   createEmpty 
)

getAnnotations( 
   createEmpty: boolean 
): JQueryPromise<AnnContainer[]>;

Parameters

createEmpty

true to create and return an empty LEADTOOLS annotations container if the page does not have one originally, otherwise;

false to return null if the page does not have an original container.

Return Value

A Promise object that may resolve successfully to an array of AnnContainer objects for each page. The user must use the value of AnnContainer.PageNumber to determine the page(s).

Remarks

GetAnnotations and SetAnnotations can be used to get or set an array of annotations container objects for all pages with a single call. Since the annotations can be stored in a stand-alone file, calling these optimized methods can be a lot faster than iterating through each page and calling DocumentPage.GetAnnotations or DocumentPage.SetAnnotations multiple times.

The result array will contain an AnnContainer was false and the page does not have any annotations).

Each AnnContainer returned will have its AnnContainer.PageNumber property set to the 1-based page number of the page.

The LEADTOOLS Document Viewer library uses GetAnnotations to obtain the annotation container objects for all pages at once instead of calling individual DocumentPage.GetAnnotations when a new document is loaded in the viewer. And will call SetAnnotations passing any annotation container that has changed by the user instead of DocumentPage.SetAnnotations in preparations for sending the document to the converter for saving.

Requirements

Target Platforms