PdfPageCollection
Represents a collection of pages in a PDF document. Provides indexed access to individual objects and methods to manipulate the page structure.
from nutrient_sdk import PdfPageCollectionConstruction
PdfPageCollection cannot be instantiated directly. Obtain instances through static factory methods or via other SDK classes.
Methods
add
def add(self) -> PdfPagedef add(self, width: float, height: float) -> PdfPagedef add(self, page_size: PdfPageSizes) -> PdfPageAdds a new page at the end of the document with the default A4 page size.
Parameters:
| Name | Type | Description |
|---|---|---|
width (optional) | float | Width of the new page in points. |
height (optional) | float | Height of the new page in points. |
page_size (optional) | PdfPageSizes | The predefined page size. |
Returns: PdfPage - The newly created . Raises:
SdkException: Thrown when the operation fails.
get_page
def get_page(self, page_number: int) -> PdfPageReturns a page by its 1-based page number.
Parameters:
| Name | Type | Description |
|---|---|---|
page_number | int | The 1-based page number. |
Returns: PdfPage - The with the specified page number. Raises:
IndexOutOfBoundsException: Thrown when pageNumber is out of range.
insert
def insert(self, index: int) -> PdfPagedef insert(self, index: int, width: float, height: float) -> PdfPagedef insert(self, index: int, page_size: PdfPageSizes) -> PdfPageInserts a new page at the specified position with the default A4 page size.
Parameters:
| Name | Type | Description |
|---|---|---|
index | int | The 0-based index at which to insert the new page. |
width (optional) | float | Width of the new page in points. |
height (optional) | float | Height of the new page in points. |
page_size (optional) | PdfPageSizes | The predefined page size. |
Returns: PdfPage - The newly created . Raises:
IndexOutOfBoundsException: Thrown when index is out of range.SdkException: Thrown when the operation fails.
move_to
def move_to(self, source_index: int, destination_index: int) -> NoneMoves a page from one position to another.
Parameters:
| Name | Type | Description |
|---|---|---|
source_index | int | The 0-based index of the page to move. |
destination_index | int | The 0-based index of the destination position. |
Raises:
IndexOutOfBoundsException: Thrown when either index is out of range.SdkException: Thrown when the operation fails.
remove_at
def remove_at(self, index: int) -> NoneRemoves the page at the specified 0-based index.
Parameters:
| Name | Type | Description |
|---|---|---|
index | int | The 0-based index of the page to remove. |
Raises:
IndexOutOfBoundsException: Thrown when index is out of range.SdkException: Thrown when the operation fails.
swap
def swap(self, index1: int, index2: int) -> NoneSwaps two pages in the document.
Parameters:
| Name | Type | Description |
|---|---|---|
index1 | int | The 0-based index of the first page. |
index2 | int | The 0-based index of the second page. |
Raises:
IndexOutOfBoundsException: Thrown when either index is out of range.SdkException: Thrown when the operation fails.
Properties
count
@propertydef count(self) -> intThe number of pages in the collection.
Type: int
Read-only property.
enumerator
@propertydef enumerator(self) -> IEnumerator`1Returns an enumerator that iterates through the pages collection.
Type: IEnumerator1`
Read-only property.
first
@propertydef first(self) -> PdfPageThe first page of the document, or null if the document has no pages.
Type: PdfPage
Read-only property.
last
@propertydef last(self) -> PdfPageThe last page of the document, or null if the document has no pages.
Type: PdfPage
Read-only property.