com.ironsoftware.ironpdf.annotation

Class AnnotationManager

java.lang.Object

com.ironsoftware.ironpdf.annotation.AnnotationManager

public class AnnotationManager
extends Object

Class used to add annotations to a PdfDocument.

See: PdfDocument.getAnnotation()

Constructor Summary

Constructors

Constructor and Description
AnnotationManager(com.ironsoftware.ironpdf.internal.staticapi.InternalPdfDocument internalPdfDocument) Please get AnnotationManager by PdfDocument.getAnnotation() instead.

Method Summary

Modifier and Type	Method and Description
void	addLinkAnnotation(LinkAnnotation link) Adds a clickable link annotation that navigates to another page within the same PDF document.
void	addTextAnnotation(AnnotationOptions options, int pageIndex) Adds an annotation to a page of this InternalPdfDocument
int	getAnnotationCount(int pageIndex) Retrieves the number of annotations contained on the specified page

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationManager

public AnnotationManager(com.ironsoftware.ironpdf.internal.staticapi.InternalPdfDocument internalPdfDocument)

Please get AnnotationManager by PdfDocument.getAnnotation() instead.

Parameters:

internalPdfDocument - the internal pdf document

Method Detail

addTextAnnotation

public void addTextAnnotation(AnnotationOptions options,
                              int pageIndex)

Adds an annotation to a page of this InternalPdfDocument

Parameters:

options - The annotation options as a AnnotationOptions object.

pageIndex - Index of the page to add the annotation. The first page has a PageIndex of 0

addLinkAnnotation

public void addLinkAnnotation(LinkAnnotation link)

Adds a clickable link annotation that navigates to another page within the same PDF document. Useful for building custom tables of contents, cross-references, and in-document navigation.

The target page and display options are configured via the LinkAnnotation fields (see LinkAnnotation.setDestinationPageIndex(int), LinkAnnotation.setDestinationType(com.ironsoftware.ironpdf.bookmark.BookmarkDestinations), and related setters). The clickable area is set via LinkAnnotation.setX(int)/LinkAnnotation.setY(int)/ LinkAnnotation.setWidth(int)/LinkAnnotation.setHeight(int).

On successful add, LinkAnnotation.getAnnotationIndex() is updated to the zero-based index of the new annotation on its page.

Parameters:

link - the link annotation to add

getAnnotationCount

public int getAnnotationCount(int pageIndex)

Retrieves the number of annotations contained on the specified page

Parameters:

pageIndex - Index of the page to get the annotation. The first page has a PageIndex of 0

Returns:

Number of annotations contained on the page