This adds long term validation to an existing signature form element that has already been signed or refreshes that information if the signature is already LTV enabled.

createTextBlock

fun PdfDocument.createTextBlock(@IntRange(from = 0) pageIndex: Int, range: ERROR CLASS: Symbol not found for Range): ERROR CLASS: Symbol not found for TextBlock

Creates a TextBlock from the given page.

getAnnotationProvider

@NonNull

abstract fun getAnnotationProvider(): AnnotationProvider

Returns AnnotationProvider object which handles annotations contained in this document.

getBookmarkProvider

@NonNull

abstract fun getBookmarkProvider(): BookmarkProvider

Returns BookmarkProvider object which handles bookmarks contained in this document.

getChangeId

abstract fun getChangeId(): Array<Byte>

Document Identifier used for AiAssistant represents if document is updated.

getCharIndexAt

abstract fun getCharIndexAt(@IntRange(from = 0) pageIndex: Int, x: Float, y: Float): Int

Return the index of the closest character whose rect intersects the given x and y coordinates.

getCheckpointer

@Nullable

abstract fun getCheckpointer(): PdfDocumentCheckpointer

Returns PdfDocumentCheckpointer object which handles the checkpoint for the document.

getDefaultDocumentSaveOptions

@NonNull

abstract fun getDefaultDocumentSaveOptions(): DocumentSaveOptions

Returns a default set of document save options which have same permissions, password and PDF version set as this document.

getDocumentId

abstract fun getDocumentId(): Array<Byte>

Returns a document identifier.

getDocumentIdString

abstract fun getDocumentIdString(): String

Returns a string representation of a document identifier.

getDocumentSignatureInfo

@NonNull

abstract fun getDocumentSignatureInfo(): DocumentSignatureInfo

Returns information about digital signatures in this document.

getDocumentSignatureInfoAsync

@NonNull

abstract fun getDocumentSignatureInfoAsync(): Single<DocumentSignatureInfo>

Returns information about digital signatures in this document.

getDocumentSource

@NonNull

abstract fun getDocumentSource(): DocumentSource

Returns source of this document.

getDocumentSources

@NonNull

abstract fun getDocumentSources(): List<DocumentSource>

Returns list of DocumentSources from which this document is loaded.

getEmbeddedFilesProvider

@NonNull

abstract fun getEmbeddedFilesProvider(): EmbeddedFilesProvider

Returns EmbeddedFilesProvider object which handles embedded files contained in this document.

getFormProvider

@NonNull

abstract fun getFormProvider(): FormProvider

Returns FormProvider object which handles forms contained in this document.

getHashForDocumentRange

abstract fun getHashForDocumentRange(@NonNull range: List<Long>, @NonNull hashAlgorithm: HashAlgorithm): Array<Byte>

abstract fun getHashForDocumentRange(sourceIndex: Int, @NonNull range: List<Long>, @NonNull hashAlgorithm: HashAlgorithm): Array<Byte>

Returns the hash of a particular byte range of the document.

getJavaScriptProvider

@NonNull

abstract fun getJavaScriptProvider(): JavaScriptProvider

Returns JavaScriptProvider object which handles JavaScript execution for this document.

getOutline

@NonNull

abstract fun getOutline(): List<OutlineElement>

Returns list of top-level (outline / table-of-contents) bookmarks.

getOutlineAsync

@NonNull

abstract fun getOutlineAsync(): Single<List<OutlineElement>>

Returns list of top-level (outline / table-of-contents) bookmarks, asynchronously.

getPageBinding

@NonNull

abstract fun getPageBinding(): PageBinding

Returns the current document's PageBinding.

getPageBox

abstract fun getPageBox(@IntRange(from = 0) pageIndex: Int, @NonNull box: PdfBox): RectF

Returns rectangle describing one of the PDF page boxes.

getPageCount

abstract fun getPageCount(): Int

Returns number of pages in this document.

getPageIndexForPageLabel

@Nullable

abstract fun getPageIndexForPageLabel(@NonNull pageLabel: String, partialMatching: Boolean): Integer

Gets the page index for the given page label.

getPageLabel

abstract fun getPageLabel(@IntRange(from = 0) pageIndex: Int, substituteWithPlainLabel: Boolean): String

Gets the page label.

getPageRotation

abstract fun getPageRotation(@IntRange(from = 0) pageIndex: Int): Int

Returns a page rotation in degrees.

getPageSize

@NonNull

abstract fun getPageSize(@IntRange(from = 0) pageIndex: Int): Size

Returns a page size in PDF points.

getPageText

@NonNull

abstract fun getPageText(@IntRange(from = 0) pageIndex: Int): String

Returns text content of the document page.

@NonNull

abstract fun getPageText(@IntRange(from = 0) pageIndex: Int, @NonNull rectF: RectF): String

Returns text content inside given page rectangle.

@NonNull

abstract fun getPageText(@IntRange(from = 0) pageIndex: Int, start: Int, length: Int): String

Returns text content between two character indexes.

getPageTextLength

abstract fun getPageTextLength(@IntRange(from = 0) pageIndex: Int): Int

Gets number of characters in text on the page.

getPageTextRects

@NonNull

abstract fun getPageTextRects(@IntRange(from = 0) pageIndex: Int, startIndex: Int, length: Int): List<RectF>

@NonNull

abstract fun getPageTextRects(@IntRange(from = 0) pageIndex: Int, startIndex: Int, length: Int, markupPadding: Boolean): List<RectF>

Returns the rects of the range of characters on a page.

getPdfMetadata

@NonNull

abstract fun getPdfMetadata(): DocumentPdfMetadata

Returns metadata (title, author, creation date, ...) of this document, stored in the PDF document dictionary.

getPdfProjection

@NonNull

abstract fun getPdfProjection(): PdfProjection

Returns auxiliary projection class for mapping coordinate space between raw and normalized Pdf.

getPdfVersion

@NonNull

abstract fun getPdfVersion(): PdfVersion

Returns current PDF version of the document.

getPermanentId

abstract fun getPermanentId(): Array<Byte>

Unique Document Identifier used for AiAssistant.

getPermissions

@NonNull

abstract fun getPermissions(): EnumSet<DocumentPermissions>

Returns set of currently applied permission flags on this document.

getRotationOffset

abstract fun getRotationOffset(@IntRange(from = 0) pageIndex: Int): Int

Returns the rotation offset applied to this page in degrees.

getSecondaryMeasurementUnit

@Nullable

abstract fun getSecondaryMeasurementUnit(): SecondaryMeasurementUnit

Gets the secondary unit value from the document

getTextForBlocks

abstract fun getTextForBlocks(@NonNull textBlocks: List<TextBlock>): String

Returns page text for a list of text blocks.

getTitle

@Nullable

abstract fun getTitle(): String

Returns a document title.

getUid

@NonNull

abstract fun getUid(): String

This is the unique identifier for this document.

getXmpMetadata

@NonNull

abstract fun getXmpMetadata(): DocumentXmpMetadata

Returns document metadata stored in the XMP metadata entries included in the PDF file.

hasEmbeddedFile

abstract fun hasEmbeddedFile(): Boolean

Returns whether the document has any embedded files.

hasOutline

abstract fun hasOutline(): Boolean

Checks whether this document has outline / table of contents

hasPermission

abstract fun hasPermission(@NonNull permission: DocumentPermissions): Boolean

Test document permission flags.

initPageCache

abstract fun initPageCache()

Pre-fetches rotations, sizes and labels for all pages on a background thread.

initPageCacheAsync

@NonNull

abstract fun initPageCacheAsync(): Completable

Pre-fetches rotations, sizes and labels for all pages on a background thread.

invalidateCache

abstract fun invalidateCache()

Invalidates the rendered cache of all the pages for this document.

invalidateCacheForPage

abstract fun invalidateCacheForPage(@IntRange(from = 0) pageIndex: Int)

Invalidates the rendered cache of the given pageIndex for this document.

isAutomaticLinkGenerationEnabled

abstract fun isAutomaticLinkGenerationEnabled(): Boolean

Whether or not automatic link generation is enabled.

isEncrypted

abstract fun isEncrypted(): Boolean

Indicates if the PDF document is encrypted.

isWatermarkFilteringEnabled

abstract fun isWatermarkFilteringEnabled(): Boolean

Whether or not watermark filtering is enabled.

isWritableAndCanSave

abstract fun isWritableAndCanSave(): Boolean

Query whether the document data source is read/write (is not compounded and comes from a supported source) and whether saving is enabled.

renderPageToBitmap

@NonNull

abstract fun renderPageToBitmap(@NonNull context: Context, pageIndex: Int, width: Int, height: Int): Bitmap

@NonNull

abstract fun renderPageToBitmap(@NonNull context: Context, pageIndex: Int, width: Int, height: Int, @NonNull configuration: PageRenderConfiguration): Bitmap

Renders page to a bitmap.

renderPageToBitmapAsync

@NonNull

abstract fun renderPageToBitmapAsync(@NonNull context: Context, pageIndex: Int, width: Int, height: Int): Single<Bitmap>

@NonNull

abstract fun renderPageToBitmapAsync(@NonNull context: Context, @IntRange(from = 0) pageIndex: Int, width: Int, height: Int, @NonNull configuration: PageRenderConfiguration): Single<Bitmap>

Renders page to a bitmap.

save

abstract fun save(@NonNull path: String)

abstract fun save(@NonNull path: String, @NonNull saveOptions: DocumentSaveOptions)

Saves the document to an external file even if it hasn't been changed.

saveAsync

@NonNull

abstract fun saveAsync(@NonNull path: String): Completable

@NonNull

abstract fun saveAsync(@NonNull path: String, @NonNull saveOptions: DocumentSaveOptions): Completable

Saves the document to an external file even if it hasn't been changed.

saveIfModified

abstract fun saveIfModified(): Boolean

abstract fun saveIfModified(@NonNull saveOptions: DocumentSaveOptions): Boolean

Saves the document to original location if it has been changed.

abstract fun saveIfModified(@NonNull path: String): Boolean

abstract fun saveIfModified(@NonNull path: String, @NonNull saveOptions: DocumentSaveOptions): Boolean

Saves the document to passed location if it has been changed.

saveIfModifiedAsync

@NonNull

abstract fun saveIfModifiedAsync(): Single<Boolean>

@NonNull

abstract fun saveIfModifiedAsync(@NonNull saveOptions: DocumentSaveOptions): Single<Boolean>

Saves the document back to original location if it has been changed.

@NonNull

abstract fun saveIfModifiedAsync(@NonNull path: String): Single<Boolean>

@NonNull

abstract fun saveIfModifiedAsync(@NonNull path: String, @NonNull saveOptions: DocumentSaveOptions): Single<Boolean>

Saves the document to an external file if it has been changed.

setAutomaticLinkGenerationEnabled

abstract fun setAutomaticLinkGenerationEnabled(enabled: Boolean)

Enables or disables automatic link generation.

setPageBinding

abstract fun setPageBinding(@NonNull pageBinding: PageBinding)

Sets the PageBinding controlling in which direction pages of documents are laid out.

setRotationOffset

abstract fun setRotationOffset(pageRotation: Int, @IntRange(from = 0) pageIndex: Int)

Applies a temporary rotation to the specified page of this document.

setRotationOffsets

abstract fun setRotationOffsets(@NonNull pageRotations: SparseIntArray)

Applies a temporary rotation to the specified pages of this document.

setSecondaryMeasurementUnit

abstract fun setSecondaryMeasurementUnit(@NonNull secondaryMeasurementUnit: SecondaryMeasurementUnit)

Sets the secondary unit value on the document.

setWatermarkTextFilteringEnabled

abstract fun setWatermarkTextFilteringEnabled(enabled: Boolean)

Enables or disables filtering of watermark text in text retrieval methods.

wasModified

abstract fun wasModified(): Boolean

Returns true if this document was modified and should be saved to retain changes.