phpdftk API Documentation

GoToEAction extends Action
in package

Go-to-embedded action (/S /GoToE) — ISO 32000-2 §12.6.4.4.

Navigates to a destination inside an embedded PDF.

Attributes
#[RequiresPdfVersion]
\Phpdftk\Pdf\Core\PdfVersion::V1_6

Table of Contents

Constants

PDF_TYPE  = 'Action'

Properties

$d  : mixed
$f  : FileSpec|PdfReference|null
$generationNumber  : int
$newWindow  : bool|null
$next  : PdfReference|null
$objectNumber  : int
$t  : PdfDictionary|null

Methods

__construct()  : mixed
getActionType()  : string
Returns the /S (action type) value for this action.
toIndirectObject()  : string
Wrap the object in an indirect object structure: X Y obj ... endobj
toPdf()  : string
Serialize the object's dictionary/value to PDF syntax.
baseDictionary()  : PdfDictionary
Build a dictionary pre-populated with the common /Type, /S, and /Next entries so subclasses only need to add their subtype-specific fields.

Constants

PDF_TYPE

public mixed PDF_TYPE = 'Action'

Properties

$generationNumber

public int $generationNumber = 0

Methods

__construct()

public __construct(mixed $dest) : mixed
Parameters
$dest : mixed

getActionType()

Returns the /S (action type) value for this action.

public getActionType() : string
Return values
string

toIndirectObject()

Wrap the object in an indirect object structure: X Y obj ... endobj

public toIndirectObject() : string
Return values
string

toPdf()

Serialize the object's dictionary/value to PDF syntax.

public toPdf() : string
Return values
string

baseDictionary()

Build a dictionary pre-populated with the common /Type, /S, and /Next entries so subclasses only need to add their subtype-specific fields.

protected baseDictionary() : PdfDictionary
Return values
PdfDictionary

        
On this page

Search results