Actions

  • Undocumented

    See more

    Declaration

    Objective-C

    
@interface PSPDFAbstractFormAction : PSPDFAction

    Swift

    class AbstractFormAction : Action

  • Defines an action that is defined in the PDF spec, either from an outline or an annotation object. See the Adobe PDF Specification for more about actions and action types.

    Note

    The PDF spec defines both ‘destinations’ and ‘actions’. PSPDFKit will convert a ‘destination’ into an equivalent PSPDFActionTypeGoTo.
    See more

    Declaration

    Objective-C

    
@interface PSPDFAction : PSPDFModel <NSSecureCoding>

    Swift

    class Action : ModelObject, NSSecureCoding

  • Keeps track of executed Action instances, allowing us to navigate through the action history.

    Note

    This class is conceptually similar to WKBackForwardList.
    See more

    Declaration

    Objective-C

    
@interface PSPDFBackForwardActionList : NSObject <PSPDFOverridable>

    Swift

    class BackForwardActionList : NSObject, Overridable

  • An embedded go-to action (PDF 1.6) is similar to a remote go-to action but allows jumping to or from a PDF file that is embedded in another PDF file.

    See more

    Declaration

    Objective-C

    
@interface PSPDFEmbeddedGoToAction : PSPDFGoToAction

    Swift

    class EmbeddedGoToAction : GoToAction

  • Defines the action of going to a specific location within the PDF document.

    See more

    Declaration

    Objective-C

    
@interface PSPDFGoToAction : PSPDFAction

    Swift

    class GoToAction : Action

  • A hide action (PDF 1.2) hides or shows one or more annotations on the screen by setting or clearing their Hidden flags (see 12.5.3, “Annotation Flags”). This type of action can be used in combination with appearance streams and trigger events (Sections 12.5.5, “Appearance Streams,” and 12.6.3, “Trigger Events”) to display pop-up help information on the screen.

    See more

    Declaration

    Objective-C

    
@interface PSPDFHideAction : PSPDFAction

    Swift

    class HideAction : Action

  • Defines an action that contains JavaScript to be executed in the document context.

    See more

    Declaration

    Objective-C

    
@interface PSPDFJavaScriptAction : PSPDFAction

    Swift

    class JavaScriptAction : Action

  • Defines methods used to work with actions in PDF documents, some of which are named in the Adobe PDF Specification.

    See more

    Declaration

    Objective-C

    
@interface PSPDFNamedAction : PSPDFAction

    Swift

    class NamedAction : Action

  • Defines an action to go to a specific page index in another PDF document. Can be either used directly via a page index, or via a named destination, which will be resolved before executing the action. This covers both RemoteGoTo and Launch actions.

    See more

    Declaration

    Objective-C

    
@interface PSPDFRemoteGoToAction : PSPDFGoToAction

    Swift

    class RemoteGoToAction : GoToAction

  • A rendition action (PDF 1.5) controls the playing of multimedia content (see PDF Reference 1.7, 13.2, “Multimedia”).

    Note

    JavaScript actions are not supported.
    See more

    Declaration

    Objective-C

    
@interface PSPDFRenditionAction : PSPDFAction

    Swift

    class RenditionAction : Action

  • Reset Form Action.

    See more

    Declaration

    Objective-C

    
@interface PSPDFResetFormAction : PSPDFAbstractFormAction

    Swift

    class ResetFormAction : AbstractFormAction

  • A rich-media-execute action identifies a rich media annotation and specifies a command to be sent to that annotation’s handler. (See Section 9.6, “Rich Media” on page 76 of the Adobe® Supplement to the ISO 32000)

    See more

    Declaration

    Objective-C

    
@interface PSPDFRichMediaExecuteAction : PSPDFAction

    Swift

    class RichMediaExecuteAction : Action

  • Submit-Form-Action: Send data to a uniform resource locator. PDF 1.2.

    See more

    Declaration

    Objective-C

    
@interface PSPDFSubmitFormAction : PSPDFAbstractFormAction

    Swift

    class SubmitFormAction : AbstractFormAction

  • Opens a URL target. This can be similar to a PSPDFRemoteGoToAction if a pspdfkit:// URL with a page target is used.

    See more

    Declaration

    Objective-C

    
@interface PSPDFURLAction : PSPDFAction

    Swift

    class URLAction : Action