Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. AdditionalActions
          2. Annotation
          3. Annotations
          4. Contents

setasign\SetaPDF2\Core\Document\Page

AdditionalActions Class representing a pages additional-actions dictionary

File: /SetaPDF v2/Core/Document/Page/AdditionalActions.php
Old class name (alias): \SetaPDF_Core_Document_Page_AdditionalActions

Class hierarchy

Summary

Methods

Properties

Properties

$_page

protected \SetaPDF_Core_Document_Page AdditionalActions::$_page

The catalog instance


Methods

__construct()

public AdditionalActions::__construct ()

The constructor.

Parameters
$page : \SetaPDF_Core_Document_Page
 

_getAction()

protected AdditionalActions::_getAction (
string $name
): ?\SetaPDF_Core_Document_Action

Get the action.

Parameters
$name : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_setAction()

protected AdditionalActions::_setAction (
string $name,
?\SetaPDF_Core_Document_Action $action = null
): void

Set the action.

Parameters
$name : string
 
$action : ?\SetaPDF_Core_Document_Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getClose()

public AdditionalActions::getClose (
void
): ?\SetaPDF_Core_Document_Action

Get the action that shall be performed when the page is closed.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getDictionary()

public AdditionalActions::getDictionary (
bool $create = false
): null|\SetaPDF_Core_Type_AbstractType|\SetaPDF_Core_Type_Dictionary

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getOpen()

public AdditionalActions::getOpen (
void
): ?\SetaPDF_Core_Document_Action

Get the action that shall be performed when the page is opened.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setClose()

public AdditionalActions::setClose (): \SetaPDF_Core_Document_Page_AdditionalActions

Set the action that shall be performed when the page is closed.

Parameters
$action : \SetaPDF_Core_Document_Action
 
Return Values

Returns the AdditionalActions object for method chaining.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setOpen()

public AdditionalActions::setOpen (): \SetaPDF_Core_Document_Page_AdditionalActions

Set the action that shall be performed when the page is opened.

Parameters
$action : \SetaPDF_Core_Document_Action
 
Return Values

Returns the AdditionalActions object for method chaining.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception


© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)