IronPDFを使用してPythonで簡単にPDFに注釈を入れる方法

Prerequisites

Before diving into annotating PDFs using IronPDF, ensure you have the following prerequisites in place:

1. Python: Ensure that Python is installed on your computer. To download the latest version, visit the official Python website.
2. Install an IDE: Before you can start working on your PDFs with IronPDF, you will need to install an IDE. PyCharm is recommended as a popular integrated development environment (IDE) for Python. Alternatively, you can use any IDE of your choice if you don't want to use PyCharm.

3. IronPDF Library: Install the IronPDF library using the following command in the terminal:

   pip install IronPDF

   pip install IronPDF

   SHELL

   Install IronPDF package

4. .NET 6.0 Runtime: IronPDF for Python relies on .NET 6.0 technology to work properly. This means you need to have .NET 6.0 runtime installed on your computer to use IronPDF for Python effectively. Most likely, it will automatically install with IronPDF dependencies at the time of project execution.

Note: When installing IronPDF using pip (Python Package Manager), it is important to ensure that the IronPDF installation path is included in the system's PATH variable. This step is crucial to ensure that pip can locate the IronPDF package and its associated components during installation and usage.

Step 1: Importing the IronPDF Library

The first line imports the required modules from the IronPDF library, allowing access to the necessary classes and functions for PDF manipulation and annotation.

from ironpdf import PdfDocument, TextAnnotation

from ironpdf import PdfDocument, TextAnnotation

Step 2: Loading an Existing PDF Document

In this step, an existing PDF file named "existing.pdf" is loaded using the PdfDocument class. This document will be used as the base to add annotations. Also, set the page index on which supported annotation types will be added.

# Load the PDF document and set the target page index for annotation
pdf = PdfDocument("existing.pdf")
pageIndex = 0

# Load the PDF document and set the target page index for annotation
pdf = PdfDocument("existing.pdf")
pageIndex = 0

Step 3: Setting Annotation Parameters

The following lines of code define various properties for text annotation that will be added to the PDF. These properties provide information about the annotation's appearance and behavior:

# Create a text annotation and configure its properties
annotation = TextAnnotation(pageIndex)
annotation.Title = "This is the major title"
annotation.Subject = "This is a subtitle"
annotation.Contents = "This is the long 'sticky note' comment content..."
annotation.Icon = TextAnnotation.AnnotationIcon.Help
annotation.X = 150
annotation.Y = 200
annotation.Width = 200
annotation.Height = 50
annotation.Opacity = 0.9
annotation.Printable = False
annotation.Hidden = False
annotation.OpenByDefault = True
annotation.ReadOnly = False
annotation.Rotatable = True

# Create a text annotation and configure its properties
annotation = TextAnnotation(pageIndex)
annotation.Title = "This is the major title"
annotation.Subject = "This is a subtitle"
annotation.Contents = "This is the long 'sticky note' comment content..."
annotation.Icon = TextAnnotation.AnnotationIcon.Help
annotation.X = 150
annotation.Y = 200
annotation.Width = 200
annotation.Height = 50
annotation.Opacity = 0.9
annotation.Printable = False
annotation.Hidden = False
annotation.OpenByDefault = True
annotation.ReadOnly = False
annotation.Rotatable = True

Here's what each property represents:

• Annotation: Setting up the annotation variable and declaring the annotation type.
• Title: The major title of the new annotation.
• Subject: A subtitle or additional information about the annotation.
• Contents: The main content of the annotation, resembles a "sticky note" comment.
• Icon: The visual icon associated with the annotation (in this case, a help icon).
• X and Y: The coordinates of the annotation's top-left corner on the page.
• Width and Height: The dimensions of the annotation's bounding box.
• Opacity: The opacity level of the annotation (ranging from 0 to 1).
• Printable: Whether the annotation should be printed.
• Hidden: Whether the annotation is initially hidden.
• OpenByDefault: Whether the annotation should be open by default.
• ReadOnly: Whether the annotation is read-only.
• Rotatable: Whether the annotation can be rotated.

For more annotation types and properties visit this code examples page.

Step 4: Adding the Annotation to the PDF

The following line of code adds the created text annotation to a specific page within the PDF document:

# Add the text annotation to the specified page in the PDF document
pdf.Annotations.Add(annotation)

# Add the text annotation to the specified page in the PDF document
pdf.Annotations.Add(annotation)

Step 5: Saving the Annotated PDF

Finally, the updated PDF document with the added annotation is saved using the SaveAs method:

# Save the PDF document with the new annotations
pdf.SaveAs("annotated.pdf")

# Save the PDF document with the new annotations
pdf.SaveAs("annotated.pdf")

Step 6: Running the Script

Now, let's put all the code together and run the script in the PyCharm project that was created earlier.

1. To run the script within PyCharm, right-click anywhere within the script editor and select Run annotatePDF.
2. PyCharm will execute the script, and you will see the output and any potential errors in the Run console at the bottom of the IDE.
3. Once the script is completed, you can find the annotated PDF ("annotated.pdf") in the same directory as your project.

Output:

The output PDF file