PageLabelCollection

PageLabelCollection

Overview

PageLabelCollection is a class in Aspose.PDF FOSS for Python.

A document’s label ranges, keyed by the index of the page each starts at.

This class declares 9 methods for PageLabelCollection objects in Python programs. Available methods include: __delitem__, __getitem__, __init__, __iter__, __len__, __repr__, __setitem__, clear, label. Public members are accessible to any Python application after installing the Aspose.PDF FOSS for Python package.

Methods

SignatureDescription
__init__(document: Document)Calls init(document) on this PageLabelCollection instance.
__getitem__(start: int) → PageLabelCalls getitem(start) on this PageLabelCollection instance.
__setitem__(start: int, label: PageLabel)Calls setitem(start, label) on this PageLabelCollection instance.
__delitem__(start: int)Calls delitem(start) on this PageLabelCollection instance.
__iter__() → Iterator[int]Calls iter on this PageLabelCollection instance.
__len__() → intCalls len on this PageLabelCollection instance.
clear()Remove the labels: the document goes back to having none.
label(page_index: int) → str | NoneThe label of page page_index, or None when the document has none.
__repr__() → strCalls repr on this PageLabelCollection instance.

See Also