A wrapper for action dictionaries (ISO 32000-1 section 12.6). More...

Inheritance diagram for iText.Kernel.Pdf.Action.PdfAction:

Public Member Functions
	PdfAction ()
	Constructs an empty action that can be further modified. More...

	PdfAction (PdfDictionary pdfObject)
	Constructs a PdfAction instance with a given dictionary. More...

virtual void	Next (iText.Kernel.Pdf.Action.PdfAction nextAction)
	Adds a chained action. More...

virtual iText.Kernel.Pdf.Action.PdfAction	Put (PdfName key, PdfObject value)
	Inserts the value into the underlying object of this PdfAction and associates it with the specified key. More...

override void	Flush ()
	To manually flush a `PdfObject` behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. More...

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual bool	IsFlushed ()

Static Public Member Functions
static iText.Kernel.Pdf.Action.PdfAction	CreateGoTo (PdfDestination destination)
	Creates a GoTo action (section 12.6.4.2 of ISO 32000-1) via a given destination. More...

static iText.Kernel.Pdf.Action.PdfAction	CreateGoTo (String destination)
	Creates a GoTo action (section 12.6.4.2 of ISO 32000-1) via a given iText.Kernel.Pdf.Navigation.PdfStringDestination name. More...

static iText.Kernel.Pdf.Action.PdfAction	CreateGoToR (PdfFileSpec fileSpec, PdfDestination destination, bool newWindow)
	Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateGoToR (PdfFileSpec fileSpec, PdfDestination destination)
	Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateGoToR (String filename, int pageNum)
	Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateGoToR (String filename, int pageNum, bool newWindow)
	Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateGoToR (String filename, String destination, bool newWindow)
	Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateGoToR (String filename, String destination)
	Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateGoToE (PdfDestination destination, bool newWindow, PdfTarget targetDictionary)
	Creates a GoToE action, or embedded file action (section 12.6.4.4 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateGoToE (PdfFileSpec fileSpec, PdfDestination destination, bool newWindow, PdfTarget targetDictionary)
	Creates a GoToE action, or embedded file action (section 12.6.4.4 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateLaunch (PdfFileSpec fileSpec, bool newWindow)
	Creates a Launch action (section 12.6.4.5 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateLaunch (PdfFileSpec fileSpec)
	Creates a Launch action (section 12.6.4.5 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateThread (PdfFileSpec fileSpec, PdfObject destinationThread, PdfObject bead)
	Creates a Thread action (section 12.6.4.6 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateThread (PdfFileSpec fileSpec)
	Creates a Thread action (section 12.6.4.6 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateURI (String uri)
	Creates a URI action (section 12.6.4.7 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateURI (String uri, bool isMap)
	Creates a URI action (section 12.6.4.7 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateSound (PdfStream sound)
	Creates a Sound action (section 12.6.4.8 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateSound (PdfStream sound, float volume, bool synchronous, bool repeat, bool mix)
	Creates a Sound action (section 12.6.4.8 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateMovie (PdfAnnotation annotation, String title, PdfName operation)
	Creates a Movie annotation (section 12.6.4.9 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateHide (PdfAnnotation annotation, bool hidden)
	Creates a Hide action (section 12.6.4.10 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateHide (PdfAnnotation[] annotations, bool hidden)
	Creates a Hide action (section 12.6.4.10 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateHide (String text, bool hidden)
	Creates a Hide action (section 12.6.4.10 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateHide (String[] text, bool hidden)
	Creates a Hide action (section 12.6.4.10 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateNamed (PdfName namedAction)
	Creates a Named action (section 12.6.4.11 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateSetOcgState (IList< PdfActionOcgState > states)
	Creates a Set-OCG-State action (section 12.6.4.12 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateSetOcgState (IList< PdfActionOcgState > states, bool preserveRb)
	Creates a Set-OCG-State action (section 12.6.4.12 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateRendition (String file, PdfFileSpec fileSpec, String mimeType, PdfAnnotation screenAnnotation)
	Creates a Rendition action (section 12.6.4.13 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateJavaScript (String javaScript)
	Creates a JavaScript action (section 12.6.4.16 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateSubmitForm (String file, Object[] names, int flags)
	Creates a Submit-Form Action (section 12.7.5.2 of ISO 32000-1). More...

static iText.Kernel.Pdf.Action.PdfAction	CreateResetForm (Object[] names, int flags)
	Creates a Reset-Form Action (section 12.7.5.3 of ISO 32000-1). More...

static void	SetAdditionalAction (PdfObjectWrapper< PdfDictionary > wrapper, PdfName key, iText.Kernel.Pdf.Action.PdfAction action)
	Adds an additional action to the provided iText.Kernel.Pdf.PdfObjectWrapper < iText.Kernel.Pdf.PdfDictionary > wrapper. More...

Static Public Attributes
const int	SUBMIT_EXCLUDE = 1
	A possible submit value More...

const int	SUBMIT_INCLUDE_NO_VALUE_FIELDS = 2
	A possible submit value More...

const int	SUBMIT_HTML_FORMAT = 4
	A possible submit value More...

const int	SUBMIT_HTML_GET = 8
	A possible submit value More...

const int	SUBMIT_COORDINATES = 16
	A possible submit value More...

const int	SUBMIT_XFDF = 32
	A possible submit value More...

const int	SUBMIT_INCLUDE_APPEND_SAVES = 64
	A possible submit value More...

const int	SUBMIT_INCLUDE_ANNOTATIONS = 128
	A possible submit value More...

const int	SUBMIT_PDF = 256
	A possible submit value More...

const int	SUBMIT_CANONICAL_FORMAT = 512
	A possible submit value More...

const int	SUBMIT_EXCL_NON_USER_ANNOTS = 1024
	A possible submit value More...

const int	SUBMIT_EXCL_F_KEY = 2048
	A possible submit value More...

const int	SUBMIT_EMBED_FORM = 8196
	A possible submit value More...

const int	RESET_EXCLUDE = 1
	A possible submit value More...

Detailed Description

A wrapper for action dictionaries (ISO 32000-1 section 12.6).

A wrapper for action dictionaries (ISO 32000-1 section 12.6). An action dictionary defines the characteristics and behaviour of an action.

Constructor & Destructor Documentation

◆ PdfAction() [1/2]

iText.Kernel.Pdf.Action.PdfAction.PdfAction ( )

inline

Constructs an empty action that can be further modified.

◆ PdfAction() [2/2]

iText.Kernel.Pdf.Action.PdfAction.PdfAction ( PdfDictionary pdfObject )

inline

Constructs a PdfAction instance with a given dictionary.

Constructs a PdfAction instance with a given dictionary. It can be used for handy property reading in reading mode or modifying in stamping mode.

Parameters

pdfObject the dictionary to construct the wrapper around

Member Function Documentation

◆ CreateGoTo() [1/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoTo ( PdfDestination destination )

inlinestatic

Creates a GoTo action (section 12.6.4.2 of ISO 32000-1) via a given destination.

Parameters

destination the desired destination of the action

Returns: created action

◆ CreateGoTo() [2/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoTo ( String destination )

inlinestatic

Creates a GoTo action (section 12.6.4.2 of ISO 32000-1) via a given iText.Kernel.Pdf.Navigation.PdfStringDestination name.

Parameters

destination

iText.Kernel.Pdf.Navigation.PdfStringDestination name

Returns: created action

◆ CreateGoToE() [1/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoToE	(	PdfDestination	destination,
		bool	newWindow,
		PdfTarget	targetDictionary
	)

inlinestatic

Creates a GoToE action, or embedded file action (section 12.6.4.4 of ISO 32000-1).

Parameters

destination	the destination in the target to jump to
newWindow	if true, the destination document should be opened in a new window; if false, the destination document should replace the current document in the same window
targetDictionary	A target dictionary specifying path information to the target document. Each target dictionary specifies one element in the full path to the target and may have nested target dictionaries specifying additional elements

Returns: created action

◆ CreateGoToE() [2/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoToE	(	PdfFileSpec	fileSpec,
		PdfDestination	destination,
		bool	newWindow,
		PdfTarget	targetDictionary
	)

inlinestatic

Creates a GoToE action, or embedded file action (section 12.6.4.4 of ISO 32000-1).

Parameters

fileSpec	The root document of the target relative to the root document of the source
destination	the destination in the target to jump to
newWindow	if true, the destination document should be opened in a new window; if false, the destination document should replace the current document in the same window
targetDictionary	A target dictionary specifying path information to the target document. Each target dictionary specifies one element in the full path to the target and may have nested target dictionaries specifying additional elements

Returns: created action

◆ CreateGoToR() [1/6]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoToR	(	PdfFileSpec	fileSpec,
		PdfDestination	destination
	)

inlinestatic

Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).

Parameters

fileSpec	the file in which the destination shall be located
destination	the destination in the remote document to jump to

Returns: created action

◆ CreateGoToR() [2/6]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoToR	(	PdfFileSpec	fileSpec,
		PdfDestination	destination,
		bool	newWindow
	)

inlinestatic

Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).

Parameters

fileSpec	the file in which the destination shall be located
destination	the destination in the remote document to jump to
newWindow	a flag specifying whether to open the destination document in a new window

Returns: created action

◆ CreateGoToR() [3/6]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoToR	(	String	filename,
		int	pageNum
	)

inlinestatic

Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).

Parameters

filename	the remote destination file to jump to
pageNum	the remote destination document page to jump to

Returns: created action

◆ CreateGoToR() [4/6]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoToR	(	String	filename,
		int	pageNum,
		bool	newWindow
	)

inlinestatic

Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).

Parameters

filename	the remote destination file to jump to
pageNum	the remote destination document page to jump to
newWindow	a flag specifying whether to open the destination document in a new window

Returns: created action

◆ CreateGoToR() [5/6]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoToR	(	String	filename,
		String	destination
	)

inlinestatic

Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).

Parameters

filename	the remote destination file to jump to
destination	the string destination in the remote document to jump to

Returns: created action

◆ CreateGoToR() [6/6]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateGoToR	(	String	filename,
		String	destination,
		bool	newWindow
	)

inlinestatic

Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).

Parameters

filename	the remote destination file to jump to
destination	the string destination in the remote document to jump to
newWindow	a flag specifying whether to open the destination document in a new window

Returns: created action

◆ CreateHide() [1/4]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateHide	(	PdfAnnotation	annotation,
		bool	hidden
	)

inlinestatic

Creates a Hide action (section 12.6.4.10 of ISO 32000-1).

Parameters

annotation	the annotation to be hidden or shown
hidden	a flag indicating whether to hide the annotation (`true`) or show it (`false`)

Returns: created action

◆ CreateHide() [2/4]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateHide	(	PdfAnnotation[]	annotations,
		bool	hidden
	)

inlinestatic

Creates a Hide action (section 12.6.4.10 of ISO 32000-1).

Parameters

annotations	the annotations to be hidden or shown
hidden	a flag indicating whether to hide the annotation (`true`) or show it (`false`)

Returns: created action

◆ CreateHide() [3/4]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateHide	(	String	text,
		bool	hidden
	)

inlinestatic

Creates a Hide action (section 12.6.4.10 of ISO 32000-1).

Parameters

text	a text string giving the fully qualified field name of an interactive form field whose associated widget annotation or annotations are to be affected
hidden	a flag indicating whether to hide the annotation (`true`) or show it (`false`)

Returns: created action

◆ CreateHide() [4/4]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateHide	(	String[]	text,
		bool	hidden
	)

inlinestatic

Creates a Hide action (section 12.6.4.10 of ISO 32000-1).

Parameters

text	a text string array giving the fully qualified field names of interactive form fields whose associated widget annotation or annotations are to be affected
hidden	a flag indicating whether to hide the annotation (`true`) or show it (`false`)

Returns: created action

◆ CreateJavaScript()

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateJavaScript ( String javaScript )

inlinestatic

Creates a JavaScript action (section 12.6.4.16 of ISO 32000-1).

Parameters

javaScript a text string containing the JavaScript script to be executed.

Returns: created action

◆ CreateLaunch() [1/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateLaunch ( PdfFileSpec fileSpec )

inlinestatic

Creates a Launch action (section 12.6.4.5 of ISO 32000-1).

Parameters

fileSpec the application that shall be launched or the document that shall beopened or printed

Returns: created action

◆ CreateLaunch() [2/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateLaunch	(	PdfFileSpec	fileSpec,
		bool	newWindow
	)

inlinestatic

Creates a Launch action (section 12.6.4.5 of ISO 32000-1).

Parameters

fileSpec	the application that shall be launched or the document that shall beopened or printed
newWindow	a flag specifying whether to open the destination document in a new window

Returns: created action

◆ CreateMovie()

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateMovie	(	PdfAnnotation	annotation,
		String	title,
		PdfName	operation
	)

inlinestatic

Creates a Movie annotation (section 12.6.4.9 of ISO 32000-1).

Creates a Movie annotation (section 12.6.4.9 of ISO 32000-1). Deprecated in PDF 2.0.

Parameters

annotation	a movie annotation identifying the movie that shall be played
title	the title of a movie annotation identifying the movie that shall be played
operation	the operation that shall be performed on the movie. Shall be one of the following: iText.Kernel.Pdf.PdfName.Play , iText.Kernel.Pdf.PdfName.Stop , iText.Kernel.Pdf.PdfName.Pause , iText.Kernel.Pdf.PdfName.Resume

Returns: created annotation

◆ CreateNamed()

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateNamed ( PdfName namedAction )

inlinestatic

Creates a Named action (section 12.6.4.11 of ISO 32000-1).

Parameters

namedAction the name of the action that shall be performed. Shall be one of the following: iText.Kernel.Pdf.PdfName.NextPage , iText.Kernel.Pdf.PdfName.PrevPage , iText.Kernel.Pdf.PdfName.FirstPage , iText.Kernel.Pdf.PdfName.LastPage

Returns: created action

◆ CreateRendition()

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateRendition	(	String	file,
		PdfFileSpec	fileSpec,
		String	mimeType,
		PdfAnnotation	screenAnnotation
	)

inlinestatic

Creates a Rendition action (section 12.6.4.13 of ISO 32000-1).

Parameters

file	the name of the media clip, for use in the user interface.
fileSpec	a full file specification or form XObject that specifies the actual media data
mimeType	an ASCII string identifying the type of data
screenAnnotation	a screen annotation

Returns: created action

◆ CreateResetForm()

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateResetForm	(	Object[]	names,
		int	flags
	)

inlinestatic

Creates a Reset-Form Action (section 12.7.5.3 of ISO 32000-1).

Parameters

names	an array identifying which fields to reset or which to exclude from resetting, depending on the setting of the Include/Exclude flag in the Flags entry (see Table 239 of ISO 32000-1).
flags	a set of flags specifying various characteristics of the action (see Table 239 of ISO 32000-1). Default value to be passed: 0.

Returns: created action

◆ CreateSetOcgState() [1/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateSetOcgState ( IList< PdfActionOcgState > states )

inlinestatic

Creates a Set-OCG-State action (section 12.6.4.12 of ISO 32000-1).

Parameters

states a list of PdfActionOcgState state descriptions

Returns: created action

◆ CreateSetOcgState() [2/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateSetOcgState	(	IList< PdfActionOcgState >	states,
		bool	preserveRb
	)

inlinestatic

Creates a Set-OCG-State action (section 12.6.4.12 of ISO 32000-1).

Parameters

states	states a list of PdfActionOcgState state descriptions
preserveRb	If true, indicates that radio-button state relationships between optional content groups should be preserved when the states are applied

Returns: created action

◆ CreateSound() [1/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateSound ( PdfStream sound )

inlinestatic

Creates a Sound action (section 12.6.4.8 of ISO 32000-1).

Creates a Sound action (section 12.6.4.8 of ISO 32000-1). Deprecated in PDF 2.0.

Parameters

sound a sound object defining the sound that shall be played (see section 13.3 of ISO 32000-1)

Returns: created action

◆ CreateSound() [2/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateSound	(	PdfStream	sound,
		float	volume,
		bool	synchronous,
		bool	repeat,
		bool	mix
	)

inlinestatic

Creates a Sound action (section 12.6.4.8 of ISO 32000-1).

Creates a Sound action (section 12.6.4.8 of ISO 32000-1). Deprecated in PDF 2.0.

Parameters

sound	a sound object defining the sound that shall be played (see section 13.3 of ISO 32000-1)
volume	the volume at which to play the sound, in the range -1.0 to 1.0. Default value: 1.0
synchronous	a flag specifying whether to play the sound synchronously or asynchronously. If this flag is `true`, the conforming reader retains control, allowing no further user interaction other than canceling the sound, until the sound has been completely played. Default value: `false`
repeat	a flag specifying whether to repeat the sound indefinitely If this entry is present, the Synchronous entry shall be ignored. Default value: `false`
mix	a flag specifying whether to mix this sound with any other sound already playing

Returns: created action

◆ CreateSubmitForm()

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateSubmitForm	(	String	file,
		Object[]	names,
		int	flags
	)

inlinestatic

Creates a Submit-Form Action (section 12.7.5.2 of ISO 32000-1).

Parameters

file	a uniform resource locator, as described in 7.11.5, "URL Specifications"
names	an array identifying which fields to include in the submission or which to exclude, depending on the setting of the Include/Exclude flag in the Flags entry. This is an optional parameter and can be `null`
flags	a set of flags specifying various characteristics of the action (see Table 237 of ISO 32000-1). Default value to be passed: 0.

Returns: created action

◆ CreateThread() [1/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateThread ( PdfFileSpec fileSpec )

inlinestatic

Creates a Thread action (section 12.6.4.6 of ISO 32000-1).

Creates a Thread action (section 12.6.4.6 of ISO 32000-1). A thread action jumps to a specified bead on an article thread (see 12.4.3, "Articles"), in either the current document or a different one. Table 205 shows the action dictionary entries specific to this type of action.

Parameters

fileSpec the file containing the thread. If this entry is absent, the thread is in the current file

Returns: created action

◆ CreateThread() [2/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateThread	(	PdfFileSpec	fileSpec,
		PdfObject	destinationThread,
		PdfObject	bead
	)

inlinestatic

Creates a Thread action (section 12.6.4.6 of ISO 32000-1).

Creates a Thread action (section 12.6.4.6 of ISO 32000-1). A thread action jumps to a specified bead on an article thread (see 12.4.3, "Articles"), in either the current document or a different one. Table 205 shows the action dictionary entries specific to this type of action.

Parameters

fileSpec	the file containing the thread. If this entry is absent, the thread is in the current file
destinationThread	the destination thread
bead	the bead in the destination thread

Returns: created action

◆ CreateURI() [1/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateURI ( String uri )

inlinestatic

Creates a URI action (section 12.6.4.7 of ISO 32000-1).

Parameters

uri	the uniform resource identifier to resolve

Returns: created action

◆ CreateURI() [2/2]

static iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.CreateURI	(	String	uri,
		bool	isMap
	)

inlinestatic

Creates a URI action (section 12.6.4.7 of ISO 32000-1).

Parameters

uri	the uniform resource identifier to resolve
isMap	a flag specifying whether to track the mouse position when the URI is resolved

Returns: created action

◆ Flush()

override void iText.Kernel.Pdf.Action.PdfAction.Flush ( )

inlinevirtual

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference.

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call iText.Kernel.Pdf.PdfObjectWrapper.MakeIndirect(iText.Kernel.Pdf.PdfDocument). For example: wrapperInstance.makeIndirect(document).flush(); Note that not every wrapper require this, only those that have such warning in documentation.

Reimplemented from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.

◆ Next()

virtual void iText.Kernel.Pdf.Action.PdfAction.Next ( iText.Kernel.Pdf.Action.PdfAction nextAction )

inlinevirtual

Adds a chained action.

Parameters

nextAction the next action or sequence of actions that shall be performed after the current action

◆ Put()

virtual iText.Kernel.Pdf.Action.PdfAction iText.Kernel.Pdf.Action.PdfAction.Put	(	PdfName	key,
		PdfObject	value
	)

inlinevirtual

Inserts the value into the underlying object of this PdfAction and associates it with the specified key.

Inserts the value into the underlying object of this PdfAction and associates it with the specified key. If the key is already present in this PdfAction , this method will override the old value with the specified one.

Parameters

key	key to insert or to override
value	the value to associate with the specified key

Returns: this PdfAction instance

◆ SetAdditionalAction()

static void iText.Kernel.Pdf.Action.PdfAction.SetAdditionalAction	(	PdfObjectWrapper< PdfDictionary >	wrapper,
		PdfName	key,
		iText.Kernel.Pdf.Action.PdfAction	action
	)

inlinestatic

Adds an additional action to the provided iText.Kernel.Pdf.PdfObjectWrapper < iText.Kernel.Pdf.PdfDictionary > wrapper.

Parameters

wrapper	the wrapper to add an additional action to
key	a iText.Kernel.Pdf.PdfName specifying the name of an additional action
action	the PdfAction to add as an additional action

A possible submit value

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PdfAction() [1/2]

◆ PdfAction() [2/2]

Member Function Documentation

◆ CreateGoTo() [1/2]

◆ CreateGoTo() [2/2]

◆ CreateGoToE() [1/2]

◆ CreateGoToE() [2/2]

◆ CreateGoToR() [1/6]

◆ CreateGoToR() [2/6]

◆ CreateGoToR() [3/6]

◆ CreateGoToR() [4/6]

◆ CreateGoToR() [5/6]

◆ CreateGoToR() [6/6]

◆ CreateHide() [1/4]

◆ CreateHide() [2/4]

◆ CreateHide() [3/4]

◆ CreateHide() [4/4]

◆ CreateJavaScript()

◆ CreateLaunch() [1/2]

◆ CreateLaunch() [2/2]

◆ CreateMovie()

◆ CreateNamed()

◆ CreateRendition()

◆ CreateResetForm()

◆ CreateSetOcgState() [1/2]

◆ CreateSetOcgState() [2/2]

◆ CreateSound() [1/2]

◆ CreateSound() [2/2]

◆ CreateSubmitForm()

◆ CreateThread() [1/2]

◆ CreateThread() [2/2]

◆ CreateURI() [1/2]

◆ CreateURI() [2/2]

◆ Flush()

◆ Next()

◆ Put()

◆ SetAdditionalAction()

Member Data Documentation

◆ RESET_EXCLUDE

◆ SUBMIT_CANONICAL_FORMAT

◆ SUBMIT_COORDINATES

◆ SUBMIT_EMBED_FORM

◆ SUBMIT_EXCL_F_KEY

◆ SUBMIT_EXCL_NON_USER_ANNOTS

◆ SUBMIT_EXCLUDE

◆ SUBMIT_HTML_FORMAT

◆ SUBMIT_HTML_GET

◆ SUBMIT_INCLUDE_ANNOTATIONS

◆ SUBMIT_INCLUDE_APPEND_SAVES

◆ SUBMIT_INCLUDE_NO_VALUE_FIELDS

◆ SUBMIT_PDF

◆ SUBMIT_XFDF