Manage annotations
Once a document contains annotations you can read them, remove a single one by its id, or remove them all. The Annotator class exposes get() to list annotations and remove(...) to delete them.
Get all annotations
Call get() to return the list of annotations stored in the document. Each item exposes common properties such as id, message, page_number, and replies.
from groupdocs.annotation import Annotator
def get_all_annotations():
# Open a document that already contains annotations and list them
with Annotator("./annotated.pdf") as annotator:
annotations = annotator.get()
print(f"Found {len(annotations)} annotation(s):")
for annotation in annotations:
print(f" [{annotation.id}] {type(annotation).__name__}: {annotation.message}")
if __name__ == "__main__":
get_all_annotations()
annotated.pdf is the sample file used in this example. Click here to download it.
Remove an annotation by id
Pass the annotation_id of the annotation you want to delete to remove(...), then save the document.
from groupdocs.annotation import Annotator
def remove_annotation_by_id():
# Open an annotated document and remove a single annotation by its id
with Annotator("./annotated.pdf") as annotator:
annotations = annotator.get()
if annotations:
annotator.remove(annotation_id=annotations[0].id)
annotator.save("./output.pdf")
if __name__ == "__main__":
remove_annotation_by_id()
annotated.pdf is the sample file used in this example. Click here to download it.
Binary file (PDF, 90 KB)
Remove all annotations
To clear every annotation, read the list with get() and pass it to remove(...) through the annotations_to_delete parameter.
from groupdocs.annotation import Annotator
def remove_all_annotations():
# Open an annotated document and remove every annotation
with Annotator("./annotated.pdf") as annotator:
annotations = annotator.get()
if annotations:
annotator.remove(annotations_to_delete=annotations)
annotator.save("./output.pdf")
if __name__ == "__main__":
remove_all_annotations()
annotated.pdf is the sample file used in this example. Click here to download it.
Binary file (PDF, 88 KB)