setasign\SetaPDF2\Core\Document\Catalog
AdditionalActions Class representing the document catalog’s additional-actions dictionary
File: /SetaPDF v2/Core/Document/Catalog/AdditionalActions.php
Old class name (alias):
\SetaPDF_Core_Document_Catalog_AdditionalActions
Class hierarchy
Summary
Properties
Methods
__construct()
_getAction()
bool $instance = true
Get the action.
Parameters
- $name : string
- $instance : bool
Exceptions
_setAction()
string|\setasign\SetaPDF2\Core\Document\Action\JavaScriptAction|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $javaScriptAction
Set the action.
Parameters
- $name : string
- $javaScriptAction : string|\setasign\SetaPDF2\Core\Document\Action\JavaScriptAction|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface
Exceptions
getDictionary()
Get the "additional actions"-dictionary.
Parameters
- $create : bool
Pass true to automatically create the dictionary
Exceptions
getDidPrint()
Get the JavaScript action that shall be performed after printing the document.
Exceptions
getDidSave()
Get the JavaScript action that shall be performed after saving the document.
Exceptions
getWillClose()
Get the JavaScript action that shall be performed before closing the document.
Exceptions
getWillPrint()
Get the JavaScript action that shall be performed before printing the document.
Exceptions
getWillSave()
Get the JavaScript action that shall be performed before saving the document.
Exceptions
setDidPrint()
Set the JavaScript action that shall be performed after printing the document.
Parameters
- $javaScriptAction : string|\setasign\SetaPDF2\Core\Document\Action\JavaScriptAction|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface
Exceptions
setDidSave()
Set the JavaScript action that shall be performed after saving the document.
Parameters
- $javaScriptAction : string|\setasign\SetaPDF2\Core\Document\Action\JavaScriptAction|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface
Exceptions
setWillClose()
Set the JavaScript action that shall be performed before closing the document.
Parameters
- $javaScriptAction : string|\setasign\SetaPDF2\Core\Document\Action\JavaScriptAction|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface
Exceptions
setWillPrint()
Set the JavaScript action that shall be performed before printing the document.
Parameters
- $javaScriptAction : string|\setasign\SetaPDF2\Core\Document\Action\JavaScriptAction|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface
Exceptions
setWillSave()
Set the JavaScript action that shall be performed before saving the document.
Parameters
- $javaScriptAction : string|\setasign\SetaPDF2\Core\Document\Action\JavaScriptAction|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface