Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Action
          1. Action
          2. FormAction
          3. GoToAction
          4. GoToRAction
          5. ImportDataAction
          6. JavaScriptAction
          7. LaunchAction
          8. NamedAction
          9. ResetAction
          10. SubmitFormAction
          11. UriAction

setasign\SetaPDF2\Core\Document\Action

GoToRAction Class representing a remote go-to action.

File: /SetaPDF v2/Core/Document/Action/GoToRAction.php
Old class name (alias): \SetaPDF_Core_Document_Action_GoToR

Go to a destination in another PDF file instead of the current file. See PDF 32000-1:2008 - 12.6.4.3

Class hierarchy

Summary

Static Methods

Methods

Properties

Properties

$_actionDictionary

protected \setasign\SetaPDF2\Core\Type\PdfDictionary Action::$_actionDictionary

The action dictionary

$_indirectReference

protected \setasign\SetaPDF2\Core\Type\IndirectObjectInterface Action::$_indirectReference

Static Methods

byObjectOrDictionary()

public static Action::byObjectOrDictionary (): Action

Creates an action object by an action dictionary.

Parameters
$objectOrDictionary : \setasign\SetaPDF2\Core\Type\PdfIndirectObject|\setasign\SetaPDF2\Core\Type\PdfIndirectReference|\setasign\SetaPDF2\Core\Type\PdfDictionary
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \InvalidArgumentException

createActionDictionary()

public static GoToRAction::createActionDictionary (): \setasign\SetaPDF2\Core\Type\PdfDictionary

Create a remote go-to Action dictionary.

Parameters
$destination : string|\setasign\SetaPDF2\Core\Type\PdfArray|\setasign\SetaPDF2\Core\Type\PdfName|\setasign\SetaPDF2\Core\Type\PdfString
 
$file : string|\setasign\SetaPDF2\Core\FileSpecification|\setasign\SetaPDF2\Core\Type\PdfDictionary

The path to the file, a file specification or a dictionary representing a file specification.

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception


Methods

__construct()

public GoToRAction::__construct ()

The constructor.

Parameters
$objectOrDictionary : string|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface
 
Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

addNext()

public Action::addNext (): void

Adds an additional action to the next value of this action.

Parameters
$next : \setasign\SetaPDF2\Core\Type\PdfDictionary|Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getActionDictionary()

public Action::getActionDictionary (
void
): \setasign\SetaPDF2\Core\Type\PdfDictionary

Get the action dictionary.

getDestination()

public GoToRAction::getDestination (): bool|\setasign\SetaPDF2\Core\Document\Destination

Get the destination object.

Parameters
$document : ?\setasign\SetaPDF2\Core\Document
 
Exceptions

Throws \BadMethodCallException

getFile()

public GoToRAction::getFile (
void
): bool|\setasign\SetaPDF2\Core\FileSpecification

Get the file in which the destination shall be located.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getIndirectObject()

public Action::getIndirectObject (): \setasign\SetaPDF2\Core\Type\IndirectObjectInterface

Get the indirect object of this annotation or creates it in the specific document context.

Parameters
$document : ?\setasign\SetaPDF2\Core\Document

The document instance

getNewWindow()

public GoToRAction::getNewWindow (
void
): ?bool

Get the flag specifying whether to open the destination document in a new window.

Return Values

A bool value if specified. Otherwise "null".

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getNext()

public Action::getNext (
void
): false|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\PdfArray|\setasign\SetaPDF2\Core\Type\PdfIndirectReference

Gets the PDF value of the next entry.

getPdfValue()

public Action::getPdfValue (
void
): \setasign\SetaPDF2\Core\Type\PdfDictionary

Get the PDF value of this action.

getType()

public Action::getType (
void
): string

Get the action type specified in the S key.

setDestination()

public GoToRAction::setDestination (): void

Set the destination.

Parameters
$destination : string|\setasign\SetaPDF2\Core\Type\PdfArray|\setasign\SetaPDF2\Core\Type\PdfName|\setasign\SetaPDF2\Core\Type\PdfString|\setasign\SetaPDF2\Core\Document\Destination
 
Exceptions

Throws \InvalidArgumentException

setFile()

public GoToRAction::setFile (): void

Set the file in which the destination shall be located.

Parameters
$file : \setasign\SetaPDF2\Core\FileSpecification|string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setIndirectObject()

public Action::setIndirectObject (): void

Set the indirect object of this annotation.

Parameters
$indirectReference : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface
 

setNewWindow()

public GoToRAction::setNewWindow (
?bool $newWindow
): void

Set the flag specifying whether to open the destination document in a new window.

Parameters
$newWindow : ?bool

Whether to open the destination in a new window or not. To use the reader preferences remove this flag by passing "null".

setNext()

public Action::setNext (): void

Set the next action which should be executed after this one.

Parameters
$next : \setasign\SetaPDF2\Core\Type\PdfDictionary|Action|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface
 

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