Action Class

Action that is triggered when the document is opened. The returned action can be either a destination or some other kind of Action (see Section 8.5, 'Actions' in PDF Reference Manual).

Sets the Action that will be triggered when the document is opened.

Actions are typically what happens when a user clicks on a link or bookmark. Instead of simply jumping to a destination in the document, an annotation or outline item can specify an action for the viewer application to perform, such as launching an application, playing a sound, or changing an annotation's appearance state.

Inheritance Hierarchy

SystemObject
pdftron.PDFAction

Namespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class Action : IClosable

Public NotInheritable Class Action
	Implements IClosable

public ref class Action sealed : IClosable

pdftron.PDF.Action = function();

Type.createClass(
	'pdftron.PDF.Action',
	null,
	Windows.Foundation.IClosable);

Return Value

Type:
the open action

The Action type exposes the following members.

Constructors

	Name	Description
	Action	A constructor. Creates an Action and initializes it using given Cos/SDF object.

Top

Methods

	Name	Description
	Close
	CreateGoto(Destination)	Creates a new 'GoTo'action. GoTo action takes the user to the specified Destination view located in the same document.
	CreateGoto(String, Destination)	Creates a new 'GoTo' action using a 'Named Destination'. GoTo action takes the user to the specified 'Named Destination' view located in the same document.
	CreateGoto(Byte, Int32, Destination)	Creates a new 'GoTo' action using a 'Named Destination'. GoTo action takes the user to the specified 'Named Destination' view located in the same document.
	CreateGotoRemote(FileSpec, Int32)	Creates a new 'GoToR'action. A remote go-to action is similar to an ordinary go-to action but jumps to a destination in another PDF file instead of the current file.
	CreateGotoRemote(FileSpec, Int32, Boolean)	Creates a new 'GoToR'action. See the above method for details.
	CreateImportData	Creates a new Show/Hide Field action. A show/hide field action shows or hide certain fields when it's invoked.
	CreateJavaScript	Creates a new 'JavaScript' action. A javascript action executes a JavaScript script when it's invoked.
	CreateLaunch	Creates a new 'Launch' action. A launch action opens up a file using the most appropriate program.
	CreateResetForm	Creates a new 'Reset Form' action. A reset form action reset choosen form fields to their default value.
	CreateSubmitForm	Creates a new 'SubmitForm'action. A submit-form action transmits the names and values of selected interactive form fields to a specified uniform resource locator (URL), presumably the address of a Web server that will process them and send back a response.
	CreateURI	Create a new URI action. The URL action is typically resolved by opening a URL in the default web browser.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Executes current action; this will only work for some action types that can be executed only using the information contained in the action object or the associated PDF doc. See also PDFViewCtrl::ExecuteAction()
	ExecuteKeyStrokeAction	Execute KeyStrokeAction, this shall be performed when the user modifies a character in a text field or combo box or modifies the selection in a scrollable list box. This action checks the added text for validity and reject or modify it.
	GetDest	Gets the dest.
	GetFormActionFlag	Gets the form action flag.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetNext	Gets the next SDFObj
	GetSDFObj	Gets the SDFObj.
	GetType	Gets the type.
	IsValid	Indicates whether the Action is valid (non-null).
	NeedsWriteLock	Test whether this action needs WriteLock
	Set	Sets value to given Action object
	SetFormActionFlag	Set the value of a given field flag. Action flags are currently only used by submit and reset form actions.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

if the document does not nave associated action the returned Action will be null (i.e. Action.IsValid() returns false)

Remarks

Although the Action class provides utility functions for most commonly used action types, it is possible to read, write, and edit any action type using SDF API and dictionary entries described in Section 8.5 in the PDF Reference Manual.

Reference

pdftron.PDF Namespace