Jak łatwo dodawać adnotacje do PDF w Python używając IronPDF

Wymagania wstępne

Zanim zaczniesz dodawać adnotacje do plików PDF za pomocą IronPDF, upewnij się, że spełniasz następujące wymagania wstępne:

1. Python: Upewnij się, że Python jest zainstalowany na Twoim komputerze. Aby pobrać najnowszą wersję, odwiedź oficjalną stronę Python.
2. Zainstaluj środowisko IDE: Zanim zaczniesz pracować nad plikami PDF w IronPDF, musisz zainstalować środowisko IDE. PyCharm jest zalecanym, popularnym zintegrowanym środowiskiem programistycznym (IDE) dla języka Python. Alternatywnie, jeśli nie chcesz korzystać z PyCharm, możesz użyć dowolnego środowiska IDE.

3. Biblioteka IronPDF: Zainstaluj bibliotekę IronPDF, używając następującego polecenia w terminalu:

   pip install IronPDF

   pip install IronPDF

   SHELL

   Zainstaluj pakiet IronPDF

4. Środowisko uruchomieniowe .NET 6.0: IronPDF for Python wymaga technologii .NET 6.0 do prawidłowego działania. Oznacza to, że aby efektywnie korzystać z IronPDF for Python, musisz mieć zainstalowane środowisko uruchomieniowe .NET 6.0 na swoim komputerze. Najprawdopodobniej zostanie on automatycznie zainstalowany wraz z zależnościami IronPDF w momencie uruchomienia projektu.

Uwaga: Podczas instalacji IronPDF za pomocą pip (Python Package Manager) należy upewnić się, że ścieżka instalacyjna IronPDF znajduje się w zmiennej PATH systemu. Ten krok ma kluczowe znaczenie dla zapewnienia, że pip będzie w stanie zlokalizować pakiet IronPDF i powiązane z nim komponenty podczas instalacji i użytkowania.

Krok 1: Importowanie biblioteki IronPDF

Pierwsza linia importuje wymagane moduły z biblioteki IronPDF, umożliwiając dostęp do klas i funkcji niezbędnych do manipulacji plikami PDF i dodawania adnotacji.

from ironpdf import PdfDocument, TextAnnotation

from ironpdf import PdfDocument, TextAnnotation

Krok 2: Wczytanie istniejącego dokumentu PDF

W tym kroku istniejący plik PDF o nazwie "existing.pdf" jest ładowany przy użyciu klasy PdfDocument. Niniejszy dokument posłuży jako podstawa do dodawania adnotacji. Należy również ustawić indeks strony, na której zostaną dodane obsługiwane typy adnotacji.

# 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

Krok 3: Ustawianie parametrów adnotacji

Poniższe linie kodu definiują różne właściwości adnotacji tekstowych, które zostaną dodane do pliku PDF. Te właściwości dostarczają informacji o wyglądzie i zachowaniu adnotacji:

# 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

Oto, co oznacza każda z tych właściwości:

• Adnotacja: Konfiguracja zmiennej adnotacji i deklaracja typu adnotacji.
• Tytuł: Główny tytuł nowej adnotacji.
• Temat: Podtytuł lub dodatkowe informacje dotyczące adnotacji.
• Treść: Główna treść adnotacji przypomina komentarz w formie "karteczki samoprzylepnej".
• Ikona: Ikona wizualna powiązana z adnotacją (w tym przypadku ikona pomocy).
• X i Y: Współrzędne lewego górnego rogu adnotacji na stronie.
• Szerokość i wysokość: Wymiary ramki ograniczającej adnotację.
• Krycie: Poziom krycia adnotacji (w zakresie od 0 do 1).
• Drukowalne: Czy adnotacja powinna zostać wydrukowana.
• Ukryte: Czy adnotacja jest początkowo ukryta.
• OpenByDefault: Czy adnotacja powinna być domyślnie otwarta.
• ReadOnly: Czy adnotacja jest tylko do odczytu.
• Możliwość obracania: Czy adnotację można obrócić.

Aby zapoznać się z innymi typami adnotacji i właściwościami, odwiedź tę stronę z przykładami kodu.

Krok 4: Dodanie adnotacji do pliku PDF

Poniższy wiersz kodu dodaje utworzoną adnotację tekstową do określonej strony w dokumencie 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)

Krok 5: Zapisanie pliku PDF z adnotacjami

Na koniec zaktualizowany dokument PDF z dodaną adnotacją jest zapisywany za pomocą metody SaveAs:

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

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

Krok 6: Uruchomienie skryptu

Teraz połączmy cały kod i uruchommy skrypt w utworzonym wcześniej projekcie PyCharm.

1. Aby uruchomić skrypt w PyCharm, kliknij prawym przyciskiem myszy w dowolnym miejscu edytora skryptów i wybierz opcję Uruchom annotatePDF.
2. PyCharm uruchomi skrypt, a wynik oraz ewentualne błędy będą widoczne w konsoli Run u dołu środowiska IDE.
3. Po ukończeniu skryptu w tym samym katalogu co projekt znajdziesz plik PDF z adnotacjami ("annotated.pdf").

Wynik:

Plik PDF wynikowy