pdf-core/io.github.limuyang2.pdf.core/PdfDocument

PdfDocument

class PdfDocument : AutoCloseable

An open PDF document.

Closing is idempotent and invalidates every PdfPage descriptor created from this document. Stop using the document in UI and page operations before closing it. A closed document must never be reused. If cleanup fails, later calls to close or closeAndAwait rethrow the same failure.

Properties

val isClosed: Boolean

Whether the document has been closed.

val pageCount: Int

Number of pages. Page indexes are zero-based.

Functions

suspend fun bookmarks(): List<PdfBookmark>

Returns the document outline (bookmark tree).

open override fun close()

Closes the document and releases its PDFium resources.

suspend fun closeAndAwait()

Closes this document without blocking the calling thread while waiting for an active PDFium operation to finish.

operator fun get(pageIndex: Int): PdfPage

Returns a lightweight descriptor for the page at pageIndex.

suspend fun information(): PdfDocumentInfo

Returns structural information: version, permissions, and flags.

suspend fun metadata(): PdfMetadata

Returns the document information dictionary values.

suspend fun pageLabel(pageIndex: Int): String?

Returns the page label assigned by the page numbering tree, or null when the page has no label.