phpdftk API Documentation

AdditionalActions extends PdfObject
in package

Additional-actions dictionary — ISO 32000-2 §12.6.3, Tables 194–197.

Referenced from /AA on a Catalog, Page, Annotation, or Form field. The set of valid trigger-event keys depends on the parent type:

  • Catalog: WC WS DS WP DP
  • Page: O C
  • Annotation: E X D U Fo Bl PO PC PV PI
  • Form Field: K F V C

This class is permissive: it holds arbitrary trigger → action entries and does not enforce which keys are legal for which parent. The helper methods cover the common triggers; uncommon ones can be set via $this->set($trigger, $action).

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

Table of Contents

Properties

$generationNumber  : int
$objectNumber  : int
$triggers  : array<string, Action|PdfReference>

Methods

onBlur()  : self
onCalculate()  : self
onDidPrint()  : self
onDidSave()  : self
onFocus()  : self
onFormat()  : self
onKeystroke()  : self
onMouseDown()  : self
onMouseEnter()  : self
onMouseExit()  : self
onMouseUp()  : self
onPageClose()  : self
onPageInvisible()  : self
onPageOpen()  : self
onPageVisible()  : self
onValidate()  : self
onWillClose()  : self
onWillPrint()  : self
onWillSave()  : self
set()  : self
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.

Properties

$generationNumber

public int $generationNumber = 0

Methods

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

        
On this page

Search results