nutrient/com.pspdfkit.annotations.actions/GoToEmbeddedAction

GoToEmbeddedAction

class GoToEmbeddedAction(val pdfPath: String?, @IntRange(from = 0) val pageIndex: Int, val isNewWindow: Boolean, subActions: List<Action> = emptyList(), val destination: Destination = Destination( pageIndex = pageIndex, type = DestinationType.FitPage, left = 0f, top = 0f, width = 0f, height = 0f, zoom = 0f )) : Action

Action that allows jumping to a PDF file that is embedded in the document.

See also

Constructors

Link copied to clipboard
constructor(pdfPath: String?, @IntRange(from = 0) pageIndex: Int, isNewWindow: Boolean, subActions: List<Action> = emptyList(), destination: Destination = Destination( pageIndex = pageIndex, type = DestinationType.FitPage, left = 0f, top = 0f, width = 0f, height = 0f, zoom = 0f ))
constructor(embeddedFile: EmbeddedFile, openInNewWindow: Boolean)

Creates action instance.

Properties

Link copied to clipboard
val destination: Destination

The destination details including position and zoom level on the target page.

Link copied to clipboard
val isNewWindow: Boolean

Whether to open the embedded file in a new window.

Link copied to clipboard
val pageIndex: Int

The zero-based index of the target page in the embedded document.

Link copied to clipboard
val pdfPath: String?

The path to the embedded PDF file, or null if not specified.

Link copied to clipboard
open override val type: ActionType

Returns type of action to make down-casting easier.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Compares this go-to-embedded action to the specified object for equality.

Link copied to clipboard
open override fun hashCode(): Int

Returns a hash code value for this go-to-embedded action.

Link copied to clipboard
open override fun toString(): String

Returns a string representation of this go-to-embedded action for debugging purposes.

Generated by Dokka
© 2026 Copyright