In This Topic ▼

setAnnotations Method

Summary

Updates the annotations container objects for one or more pages with a single call.

Syntax

TypeScript

JavaScript

DocumentAnnotations.prototype.setAnnotations = function( 
   containers 
)

setAnnotations( 
   containers: AnnContainer[] 
): JQueryPromise<void>;

Parameters

containers

One or more AnnContainer objects. The user must set the

AnnContainer.PageNumber of each item to the desired value of the page(s) to be updated. if this value is null, then all the container of all the pages in document will be cleared (this is the equivalent of iterating through each DocumentPage in the document and calling SetAnnotations with null parameter).

Return Value

A voidPromise object that may resolve successfully.

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.

containers must contain an AnnContainer object for each page in the document to be updated. This method uses the value of AnnContainer.PageNumber to update the corresponding page(s) in the document. Any item that is null will be ignored.

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