GetAnnotations Method

Summary

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

Syntax

C++

Java

public AnnContainer[] GetAnnotations( 
   bool createEmpty 
)

Public Function GetAnnotations( 
   ByVal createEmpty As Boolean 
) As AnnContainer()

public:  
   array<AnnContainer^>^ GetAnnotations( 
      bool createEmpty 
   )

public AnnContainer[] getAnnotations(boolean createEmpty)

Parameters

createEmpty

true to create and return an empty LEADTOOLS annotation 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

An array of AnnContainer objects for each page. The array can contain any number of containers and in any order. 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 annotation 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 resulting array will contain an AnnContainer object for each page in the document (or null if createEmpty 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. It will also call SetAnnotations, passing any annotation container that has been changed by the user (instead of DocumentPage.SetAnnotations), in preparation for sending the document to the converter for saving.

Requirements

Target Platforms

Reference

DocumentAnnotations Class

DocumentAnnotations Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3