如何轻松使用 IronPDF 在 Python 中注释 PDF

前提条件

在使用 IronPDF 注释 PDF 之前，请确保您已具备以下先决条件：

1. Python：确保您的计算机上已安装 Python。 要下载最新版本，请访问官方网站。
2. 安装 IDE：在您开始使用 IronPDF 处理 PDF 之前，您需要安装一个 IDE。PyCharm 是推荐的流行 Python 集成开发环境 (IDE)。 或者，如果您不想使用 PyCharm，也可以使用任何您选择的 IDE。

3. IronPDF 库：在终端中使用以下命令安装 IronPDF 库：

   pip install IronPDF

   pip install IronPDF

   SHELL

   安装 IronPDF 包

4. .NET 6.0 运行时：IronPDF for Python 依赖于 .NET 6.0 技术才能正常运行。 这意味着您需要在计算机上安装 .NET 6.0 运行时才能有效使用 IronPDF for Python。 可能在项目执行时，它会与 IronPDF 依赖项一起自动安装。

注意：使用 pip（Python 包管理器）安装 IronPDF 时，确保 IronPDF 的安装路径包含在系统的 PATH 变量中。 此步骤对于确保 pip 在安装和使用过程中能够定位 IronPDF 包及其关联组件至关重要。

步骤 1：导入 IronPDF 库

第一行从 IronPDF 库导入所需的模块，允许访问 PDF 操作和注释所需的类和函数。

from ironpdf import PdfDocument, TextAnnotation

from ironpdf import PdfDocument, TextAnnotation

步骤 2：加载现有 PDF 文档

在此步骤中，使用 PdfDocument 类加载名为“existing.pdf”的现有 PDF 文件。 该文档将用作添加注释的基础。 另外，请设置支持的注释类型将被添加的页面索引。

# 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

步骤 3：设置注释参数

以下代码行定义将要添加到 PDF 的文本注释的各种属性。 这些属性提供有关注释外观和行为的信息：

# 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

以下是每个属性代表的含义：

• Annotation：设置注释变量并声明注释类型。
• Title：新注释的主要标题。
• Subject：注释的副标题或附加信息。
• Contents：注释的主要内容，类似于“便签”评论。
• Icon：与注释关联的视觉图标（在此案例中为帮助图标）。
• X 和 Y：注释左上角在页面上的坐标。
• Width 和 Height：注释框的尺寸。
• Opacity：注释的不透明度级别（范围从 0 到 1）。
• Printable：注释是否应该打印。
• Hidden：注释是否初始隐藏。
• OpenByDefault：注释是否应该默认打开。
• ReadOnly：注释是否为只读。
• Rotatable：注释是否可以旋转。

有关更多注释类型和属性，请访问代码示例页面。

步骤 4：将注释添加到 PDF

以下代码行将创建的文本注释添加到 PDF 文档中的特定页面：

# 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)

步骤 5：保存带注释的 PDF

最后，使用 SaveAs 方法保存带有添加注释的更新 PDF 文档：

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

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

步骤 6：运行脚本

现在，让我们将所有代码放在一起并在之前创建的 PyCharm 项目中运行脚本。

1. 要在 PyCharm 中运行脚本，右键单击脚本编辑器中的任意位置，然后选择运行 annotatePDF。
2. PyCharm 将执行该脚本，您将在 IDE 底部的运行控制台中看到输出和任何潜在的错误。
3. 脚本完成后，您可以在项目相同目录中找到带注释的 PDF（“annotated.pdf”）。

输出：

输出 PDF 文件