Annotations

import com.ironsoftware.ironpdf.PdfDocument;
import com.ironsoftware.ironpdf.annotation.AnnotationIcon;
import com.ironsoftware.ironpdf.annotation.AnnotationManager;
import com.ironsoftware.ironpdf.annotation.AnnotationOptions;
import java.io.IOException;
import java.nio.file.Paths;

// Create a new PDF or load an existing one from the filesystem
PdfDocument pdf = PdfDocument.fromFile(Paths.get("assets/example.pdf"));

// Create an annotation to be placed at a specific location on a page.
AnnotationOptions annotation = new AnnotationOptions(
        "This is a major title", // Title of the annotation
        "This is the long 'sticky note' comment content...", // Content of the annotation
        150, // x-axis coordinate location
        250  // y-axis coordinate location
);
annotation.setIcon(AnnotationIcon.HELP);
annotation.setOpacity(0.9);
annotation.setPrintable(false);
annotation.setHidden(false);
annotation.setOpen(true);
annotation.setReadonly(true);
annotation.setRotateable(true);

// Add the annotation to a specific page of the PDF
AnnotationManager annotationManager = pdf.getAnnotation();
annotationManager.addTextAnnotation(annotation, 0);

// Save the PDF with the modifications
pdf.saveAs(Paths.get("assets/annotated.pdf"));

Annotations

Use a PdfDocument object's AnnotationManager, along with the AnnotationOptions class, to add "sticky note"-style annotations to specified pages of a PDF document.

Create a text-based annotation at a given location on a page by specifying the text and the cartesian (x,y) coordinates as arguments in an AnnotationOption constructor, as shown in the code example above. Next, invoke the addTextAnnotation method on the AnnotationManager to add the annotation to the desired page in the working PDF document.

Additional methods on every AnnotationOptions object enable developers to customize an annotation's appearance and behavior. In the above code example, we set its opacity and featured icon, as well as set it to not be editable or printable. Developers can also change the color, height, and title of an annotation, as well as its title, subject, content, and location.