Documentation – Annotations

Python-Net: Add Caret Annotation

Fri, 20 Mar 2026 00:00:00 +0000

Caret annotations are commonly used to indicate text insertions or editorial comments in a document. With PdfContentEditor, you can programmatically add caret annotations by specifying the page number, annotation bounds, callout area, symbol, note text, and color.

Create the PdfContentEditor object.
Bind the input PDF.
Define Caret Annotation parameters:

Page number where annotation will be added
Caret rectangle (annotation position)
Callout rectangle (text area)
Symbol (for example “P”)
Annotation text
Annotation color

Add the Caret Annotation.
Save the updated Document.

import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_caret_annotation(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add caret annotation to page 1
    content_editor.create_caret(
        1,
        apd.Rectangle(350, 400, 10, 10),
        apd.Rectangle(300, 380, 115, 15),
        "P",
        "This is a caret annotation",
        apd.Color.red,
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add Free Text Annotations

Fri, 20 Mar 2026 00:00:00 +0000

Free text annotations allow you to place visible text directly onto a PDF page without requiring pop-up comments. Using PdfContentEditor, you can specify the annotation rectangle, the displayed text, and the target page.

Create the PdfContentEditor object.
Bind the input PDF.
Define the Annotation position.
Add the Free Text Annotation.
Save the updated Document.

import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_free_text_annotation(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add free text annotation to page 1
    content_editor.create_free_text(
        apd.Rectangle(200, 480, 150, 25), "This is a free text annotation", 1
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add Markup Annotations

Fri, 20 Mar 2026 00:00:00 +0000

Markup annotations are used to emphasize or review text within a PDF. With PdfContentEditor, you can programmatically apply different markup styles by specifying a rectangle area, comment text, markup type, page number, and color.

Create the PdfContentEditor object.
Bind the input PDF.
Define Annotation rectangles.
Add Markup Annotations.
Save the updated Document.

import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_markup_annotation(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add markup annotation to page 1
    content_editor.create_markup(
        apd.Rectangle(120, 440, 200, 20),
        "This is a highlight annotation",
        0,
        1,
        apd.Color.yellow,
    )
    content_editor.create_markup(
        apd.Rectangle(110, 542, 200, 20),
        "This is a underline annotation",
        1,
        1,
        apd.Color.yellow,
    )
    content_editor.create_markup(
        apd.Rectangle(120, 568, 200, 20),
        "This is a strikeout annotation",
        2,
        1,
        apd.Color.orange_red,
    )
    content_editor.create_markup(
        apd.Rectangle(110, 598, 200, 20),
        "This is a squiggly annotation",
        3,
        1,
        apd.Color.dark_blue,
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add Popup Annotations

Fri, 20 Mar 2026 00:00:00 +0000

Popup annotations are useful for adding comments, explanations, or interactive notes in PDF files. Using PdfContentEditor, you can create popup annotations programmatically by specifying the location, content, visibility, and page number.

Create the PdfContentEditor object.
Bind the input PDF.
Define the Popup Annotation rectangle.
Add the Popup Annotation.
Save the updated Document.

import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_popup_annotation(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add popup annotation to page 1
    content_editor.create_popup(
        apd.Rectangle(220, 520, 180, 80),
        "This is a popup annotation",
        True,
        1,
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add Text Annotations

Fri, 20 Mar 2026 00:00:00 +0000

This article shows how to add a text annotation to a PDF document using the PdfContentEditor class in Aspose.PDF.

Text annotations let you attach comments, notes, or extra information to specific parts of a PDF page. These annotations can appear as icons and be expanded by users when viewing the document.

In this example:

A PDF document is loaded into the PdfContentEditor.
A text annotation is added at a specific position on the page.
The annotation includes a title, content, icon type, and visibility settings.
The modified document is saved to a new file.

Create a PdfContentEditor object.
Bind the input PDF Document.
Define annotation position.
Add Text annotation.
Save the updated PDF.

import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades
import aspose.pydrawing as apd
import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_text_annotation(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add text annotation to page 1
    content_editor.create_text(
        apd.Rectangle(100, 400, 50, 50),
        "Text Annotation",
        "This is a text annotation",
        True,
        "Insert",
        1,
    )
    # Save updated document
    content_editor.save(outfile)