如何使用 IronPDF 在 Python 中輕鬆註釋 PDF

先決條件

在利用IronPDF進行PDF註解之前，確保您已具備以下先決條件：

1. Python： 確保在您的電腦上已安裝Python。 要下載最新版本，請存取Python官網。
2. 安裝IDE： 在您開始使用IronPDF處理PDF前，您需要安裝一個IDE。PyCharm 推薦作為一個受歡迎的Python整合開發環境（IDE）。 如果您不想使用PyCharm，您可以選擇任何自己喜歡的IDE。

3. IronPDF Library： 在終端中使用以下命令安裝IronPDF程式庫：

   pip install ironpdf

   安裝 IronPDF 套件

4. .NET 6.0 Runtime： IronPDF for Python依靠.NET 6.0技術正常運行。 這意味著您需要在您的電腦上安裝 .NET 6.0 runtime 才能有效使用IronPDF for Python。 很可能在執行專案時，它會隨IronPDF的依賴自動安裝。

注意： 在使用pip（Python套件管理器）安裝IronPDF時，確保IronPDF安裝路徑已包含在系統的PATH變數中這一點非常重要。 這步驟是為了確保在安裝和使用過程中pip能夠定位IronPDF套件及其相關組件。

步驟 1：導入IronPDF Library

第一行從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中運行腳本，右鍵點擊腳本編輯器中的任何地方，然後選擇"Run annotatePDF"。
2. PyCharm將執行腳本，您將在IDE底部的"Run"控制台中看到輸出及任何潛在的錯誤。
3. 腳本完成後，您可以在專案所在目錄中找到帶註解的PDF（"annotated.pdf"）。

輸出：

輸出PDF文件