pdftools_toolbox.pdf.annotations.annotation_list

Classes

AnnotationList(handle)

A list of annotations

class pdftools_toolbox.pdf.annotations.annotation_list.AnnotationList(handle)

Bases: _NativeObject, list

A list of annotations

When a list of pdftools_toolbox.pdf.page.Page.annotations is obtained from a page that belongs to an output document, and this output document has been created with pdftools_toolbox.pdf.document.Document.create_with_fdf() , then getting the list count and individual elements results in a OperationError error. Only appending to the list is supported in this case.

clear() → None

Remove all items from list.

remove(index: int) → None

Remove first occurrence of value.

Raises ValueError if the value is not present.

extend(items: AnnotationList) → None

Extend list by appending elements from the iterable.

insert(index: int, value: Any) → None

Insert object before index.

pop(index: int = -1) → Any

Remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

copy() → AnnotationList

Return a shallow copy of the list.

sort(key=None, reverse=False) → None

Sort the list in ascending order and return None.

The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).

If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.

The reverse flag can be set to sort in descending order.

reverse() → None

Reverse IN PLACE.

append(value: Annotation) → None

Append object to the end of the list.

index(value: Annotation, start: int = 0, stop: int | None = None) → int

Return first index of value.

Raises ValueError if the value is not present.