NamedDestinationCollection
Overview
NamedDestinationCollection is a class in Aspose.PDF FOSS for Python.
The document’s named destinations, as a mapping of name to destination.
This class declares 15 methods for NamedDestinationCollection objects in Python programs.
Available methods include: __contains__, __delitem__, __getitem__, __init__, __iter__, __len__, __repr__, __setitem__, add, clear, get, items, and 3 additional methods.
Public members are accessible to any Python application after installing the Aspose.PDF FOSS for Python package.
Methods
| Signature | Description |
|---|---|
__init__(document: Document) | Calls init(document) on this NamedDestinationCollection instance. |
__len__() → int | Calls len on this NamedDestinationCollection instance. |
__iter__() → Iterator[str] | The names, in order – which is the order the file holds them in. |
__contains__(name: object) → bool | Calls contains(name) on this NamedDestinationCollection instance. |
__getitem__(name: str) → Destination | None | Calls getitem(name) on this NamedDestinationCollection instance. |
get(name: str, default: Any) → Any | The destination name lands on, or default when there is no such name. |
keys() → list[str] | Calls keys on this NamedDestinationCollection instance. |
values() → list[Destination | None] | Calls values on this NamedDestinationCollection instance. |
items() → list[tuple[str, Destination | None]] | Calls items on this NamedDestinationCollection instance. |
__setitem__(name: str, destination: Destination | int) | Calls setitem(name, destination) on this NamedDestinationCollection instance. |
add(name: str, destination: Destination | int) → Destination | Define (or replace) name, and return the destination it now names. |
__delitem__(name: str) | Calls delitem(name) on this NamedDestinationCollection instance. |
remove(name: str) → bool | Remove name; True when the document defined one. |
clear() | Remove every named destination. |
__repr__() → str | Calls repr on this NamedDestinationCollection instance. |