Inheritance diagram for iTextSharp.text.pdf.PdfAction:

Public Member Functions
	PdfAction ()

	PdfAction (Uri url)

	PdfAction (Uri url, bool isMap)

	PdfAction (string url)

	PdfAction (string url, bool isMap)

	PdfAction (string filename, string name)

	PdfAction (string filename, int page)

	PdfAction (int named)

	PdfAction (string application, string parameters, string operation, string defaultDir)

void	Next (PdfAction na)

Public Member Functions inherited from iTextSharp.text.pdf.PdfDictionary
	PdfDictionary ()

	PdfDictionary (PdfName type)

override void	ToPdf (PdfWriter writer, Stream os)

void	Put (PdfName key, PdfObject value)

void	PutEx (PdfName key, PdfObject value)

void	Remove (PdfName key)

PdfObject	Get (PdfName key)

bool	IsFont ()

bool	IsPage ()

bool	IsPages ()

bool	IsCatalog ()

bool	IsOutlineTree ()

void	Merge (PdfDictionary other)

void	MergeDifferent (PdfDictionary other)

bool	Contains (PdfName key)

virtual IDictionaryEnumerator	GetEnumerator ()

override String	ToString ()

PdfObject	GetDirectObject (PdfName key)

PdfDictionary	GetAsDict (PdfName key)

PdfArray	GetAsArray (PdfName key)

PdfStream	GetAsStream (PdfName key)

PdfString	GetAsString (PdfName key)

PdfNumber	GetAsNumber (PdfName key)

PdfName	GetAsName (PdfName key)

PdfBoolean	GetAsBoolean (PdfName key)

PdfIndirectReference	GetAsIndirectObject (PdfName key)

Public Member Functions inherited from iTextSharp.text.pdf.PdfObject
virtual byte[]	GetBytes ()

bool	CanBeInObjStm ()

override string	ToString ()

bool	IsNull ()

bool	IsBoolean ()

bool	IsNumber ()

bool	IsString ()

bool	IsName ()

bool	IsArray ()

bool	IsDictionary ()

bool	IsStream ()

bool	IsIndirect ()

Static Public Member Functions
static PdfAction	CreateLaunch (String application, String parameters, String operation, String defaultDir)

static PdfAction	Rendition (String file, PdfFileSpecification fs, String mimeType, PdfIndirectReference refi)

static PdfAction	JavaScript (string code, PdfWriter writer, bool unicode)

static PdfAction	JavaScript (string code, PdfWriter writer)

static PdfAction	CreateHide (PdfAnnotation annot, bool hide)

static PdfAction	CreateHide (string name, bool hide)

static PdfAction	CreateHide (Object[] names, bool hide)

static PdfAction	CreateSubmitForm (string file, Object[] names, int flags)

static PdfAction	CreateResetForm (Object[] names, int flags)

static PdfAction	CreateImportData (string file)

static PdfAction	GotoLocalPage (int page, PdfDestination dest, PdfWriter writer)

static PdfAction	GotoLocalPage (String dest, bool isName)

static PdfAction	GotoRemotePage (String filename, String dest, bool isName, bool newWindow)

static PdfAction	GotoEmbedded (String filename, PdfTargetDictionary target, String dest, bool isName, bool newWindow)

static PdfAction	GotoEmbedded (String filename, PdfTargetDictionary target, PdfObject dest, bool newWindow)

static PdfAction	SetOCGstate (ArrayList state, bool preserveRB)

Static Public Attributes
const int	FIRSTPAGE = 1

const int	PREVPAGE = 2

const int	NEXTPAGE = 3

const int	LASTPAGE = 4

const int	PRINTDIALOG = 5

const int	SUBMIT_EXCLUDE = 1

const int	SUBMIT_INCLUDE_NO_VALUE_FIELDS = 2

const int	SUBMIT_HTML_FORMAT = 4

const int	SUBMIT_HTML_GET = 8

const int	SUBMIT_COORDINATES = 16

const int	SUBMIT_XFDF = 32

const int	SUBMIT_INCLUDE_APPEND_SAVES = 64

const int	SUBMIT_INCLUDE_ANNOTATIONS = 128

const int	SUBMIT_PDF = 256

const int	SUBMIT_CANONICAL_FORMAT = 512

const int	SUBMIT_EXCL_NON_USER_ANNOTS = 1024

const int	SUBMIT_EXCL_F_KEY = 2048

const int	SUBMIT_EMBED_FORM = 8196

const int	RESET_EXCLUDE = 1

Static Public Attributes inherited from iTextSharp.text.pdf.PdfDictionary
static PdfName	FONT = PdfName.FONT

static PdfName	OUTLINES = PdfName.OUTLINES

static PdfName	PAGE = PdfName.PAGE

static PdfName	PAGES = PdfName.PAGES

static PdfName	CATALOG = PdfName.CATALOG

Static Public Attributes inherited from iTextSharp.text.pdf.PdfObject
const int	BOOLEAN = 1

const int	NUMBER = 2

const int	STRING = 3

const int	NAME = 4

const int	ARRAY = 5

const int	DICTIONARY = 6

const int	STREAM = 7

const int	NULL = 8

const int	INDIRECT = 10

const string	NOTHING = ""

const string	TEXT_PDFDOCENCODING = "PDF"

const string	TEXT_UNICODE = "UnicodeBig"

Additional Inherited Members
Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
	PdfObject (int type)

	PdfObject (int type, string content)

	PdfObject (int type, byte[] bytes)

Protected Attributes inherited from iTextSharp.text.pdf.PdfObject
byte[]	bytes

int	type

PRIndirectReference	indRef

Properties inherited from iTextSharp.text.pdf.PdfDictionary
ICollection	Keys `[get]`

int	Size `[get]`

Properties inherited from iTextSharp.text.pdf.PdfObject
int	Length `[get]`

string	Content `[set]`

int	Type `[get]`

PRIndirectReference	IndRef `[get, set]`

Detailed Description

A PdfAction defines an action that can be triggered from a PDF file.

See also: PdfDictionary

Constructor & Destructor Documentation

◆ PdfAction() [1/9]

iTextSharp.text.pdf.PdfAction.PdfAction ( )

Create an empty action.

◆ PdfAction() [2/9]

iTextSharp.text.pdf.PdfAction.PdfAction ( Uri url )

Constructs a new PdfAction of Subtype URI.

Parameters

url	the Url to go to

◆ PdfAction() [3/9]

iTextSharp.text.pdf.PdfAction.PdfAction	(	Uri	url,
		bool	isMap
	)

◆ PdfAction() [4/9]

iTextSharp.text.pdf.PdfAction.PdfAction ( string url )

Constructs a new PdfAction of Subtype URI.

Parameters

url	the url to go to

◆ PdfAction() [5/9]

iTextSharp.text.pdf.PdfAction.PdfAction	(	string	url,
		bool	isMap
	)

◆ PdfAction() [6/9]

iTextSharp.text.pdf.PdfAction.PdfAction	(	string	filename,
		string	name
	)

Constructs a new PdfAction of Subtype GoToR.

Parameters

filename	the file name to go to
name	the named destination to go to

◆ PdfAction() [7/9]

iTextSharp.text.pdf.PdfAction.PdfAction	(	string	filename,
		int	page
	)

Constructs a new PdfAction of Subtype GoToR.

Parameters

filename	the file name to go to
page	the page destination to go to

◆ PdfAction() [8/9]

iTextSharp.text.pdf.PdfAction.PdfAction ( int named )

Implements name actions. The action can be FIRSTPAGE, LASTPAGE, NEXTPAGE and PREVPAGE.

Parameters

named the named action

◆ PdfAction() [9/9]

iTextSharp.text.pdf.PdfAction.PdfAction	(	string	application,
		string	parameters,
		string	operation,
		string	defaultDir
	)

Launchs an application or a document.

Parameters

application	the application to be launched or the document to be opened or printed.
parameters	(Windows-specific) A parameter string to be passed to the application. It can be `null`.
operation	(Windows-specific) the operation to perform: "open" - Open a document, "print" - Print a document. It can be `null`.
defaultDir	(Windows-specific) the default directory in standard DOS syntax. It can be `null`.

Member Function Documentation

◆ CreateHide() [1/3]

static PdfAction iTextSharp.text.pdf.PdfAction.CreateHide	(	Object[]	names,
		bool	hide
	)

static

◆ CreateHide() [2/3]

static PdfAction iTextSharp.text.pdf.PdfAction.CreateHide	(	PdfAnnotation	annot,
		bool	hide
	)

static

◆ CreateHide() [3/3]

static PdfAction iTextSharp.text.pdf.PdfAction.CreateHide	(	string	name,
		bool	hide
	)

static

◆ CreateImportData()

static PdfAction iTextSharp.text.pdf.PdfAction.CreateImportData ( string file )

static

◆ CreateLaunch()

static PdfAction iTextSharp.text.pdf.PdfAction.CreateLaunch	(	String	application,
		String	parameters,
		String	operation,
		String	defaultDir
	)

static

Launchs an application or a document.

Parameters

application	the application to be launched or the document to be opened or printed.
parameters	(Windows-specific) A parameter string to be passed to the application. It can be `null`.
operation	(Windows-specific) the operation to perform: "open" - Open a document, "print" - Print a document. It can be `null`.
defaultDir	(Windows-specific) the default directory in standard DOS syntax. It can be `null`.

Returns: a Launch action

◆ CreateResetForm()

static PdfAction iTextSharp.text.pdf.PdfAction.CreateResetForm	(	Object[]	names,
		int	flags
	)

static

◆ CreateSubmitForm()

static PdfAction iTextSharp.text.pdf.PdfAction.CreateSubmitForm	(	string	file,
		Object[]	names,
		int	flags
	)

static

◆ GotoEmbedded() [1/2]

static PdfAction iTextSharp.text.pdf.PdfAction.GotoEmbedded	(	String	filename,
		PdfTargetDictionary	target,
		PdfObject	dest,
		bool	newWindow
	)

static

Creates a GoToE action to an embedded file.

Parameters

filename	the root document of the target (null if the target is in the same document)
target	a path to the target document of this action
dest	the destination inside the target document, can be of type PdfDestination, PdfName, or PdfString
newWindow	if true, the destination document should be opened in a new window

Returns: a GoToE action

◆ GotoEmbedded() [2/2]

static PdfAction iTextSharp.text.pdf.PdfAction.GotoEmbedded	(	String	filename,
		PdfTargetDictionary	target,
		String	dest,
		bool	isName,
		bool	newWindow
	)

static

Creates a GoToE action to an embedded file.

Parameters

filename	the root document of the target (null if the target is in the same document)
dest	the named destination
isName	if true sets the destination as a name, if false sets it as a String

Returns: a GoToE action

◆ GotoLocalPage() [1/2]

static PdfAction iTextSharp.text.pdf.PdfAction.GotoLocalPage	(	int	page,
		PdfDestination	dest,
		PdfWriter	writer
	)

static

Creates a GoTo action to an internal page.

Parameters

page	the page to go. First page is 1
dest	the destination for the page
writer	the writer for this action

Returns: a GoTo action

◆ GotoLocalPage() [2/2]

static PdfAction iTextSharp.text.pdf.PdfAction.GotoLocalPage	(	String	dest,
		bool	isName
	)

static

Creates a GoTo action to a named destination.

Parameters

dest	the named destination
isName	if true sets the destination as a name, if false sets it as a String

Returns: a GoToR action

◆ GotoRemotePage()

static PdfAction iTextSharp.text.pdf.PdfAction.GotoRemotePage	(	String	filename,
		String	dest,
		bool	isName,
		bool	newWindow
	)

static

Creates a GoToR action to a named destination.

Parameters

filename	the file name to go to
dest	the destination name
isName	if true sets the destination as a name, if false sets it as a String
newWindow	open the document in a new window if `true`, if false the current document is replaced by the new document.

Returns: a GoToR action

◆ JavaScript() [1/2]

static PdfAction iTextSharp.text.pdf.PdfAction.JavaScript	(	string	code,
		PdfWriter	writer
	)

static

Creates a JavaScript action. If the JavaScript is smaller than 50 characters it will be place as a string, otherwise it will be placed as a compressed stream.

Parameters

code	the JavaScript code
writer	the writer for this action

Returns: the JavaScript action

◆ JavaScript() [2/2]

static PdfAction iTextSharp.text.pdf.PdfAction.JavaScript	(	string	code,
		PdfWriter	writer,
		bool	unicode
	)

static

Creates a JavaScript action. If the JavaScript is smaller than 50 characters it will be placed as a string, otherwise it will be placed as a compressed stream.

Parameters

code	the JavaScript code
writer	the writer for this action
unicode	select JavaScript unicode. Note that the internal Acrobat JavaScript engine does not support unicode, so this may or may not work for you

Returns: the JavaScript action

◆ Next()

void iTextSharp.text.pdf.PdfAction.Next ( PdfAction na )

Add a chained action.

Parameters

na	the next action

◆ Rendition()

static PdfAction iTextSharp.text.pdf.PdfAction.Rendition	(	String	file,
		PdfFileSpecification	fs,
		String	mimeType,
		PdfIndirectReference	refi
	)

static

Creates a Rendition action

Parameters

file
fs
mimeType
ref

Returns: a Media Clip action

Exceptions

IOException

◆ SetOCGstate()

static PdfAction iTextSharp.text.pdf.PdfAction.SetOCGstate	(	ArrayList	state,
		bool	preserveRB
	)

static

A set-OCG-state action (PDF 1.5) sets the state of one or more optional content groups.

Parameters

state

an array consisting of any number of sequences beginning with a PdfName or String (ON, OFF, or Toggle) followed by one or more optional content group dictionaries PdfLayer or a PdfIndirectReference to a PdfLayer.
The array elements are processed from left to right; each name is applied to the subsequent groups until the next name is encountered:

ON sets the state of subsequent groups to ON
OFF sets the state of subsequent groups to OFF
Toggle reverses the state of subsequent groups

preserveRB if true, indicates that radio-button state relationships between optional content groups (as specified by the RBGroups entry in the current configuration dictionary) should be preserved when the states in the state array are applied. That is, if a group is set to ON (either by ON or Toggle) during processing of the state array, any other groups belong to the same radio-button group are turned OFF. If a group is set to OFF, there is no effect on other groups.
If false, radio-button state relationships, if any, are ignored

Returns: the action

Member Data Documentation

◆ FIRSTPAGE

const int iTextSharp.text.pdf.PdfAction.FIRSTPAGE = 1

static

A named action to go to the first page.

◆ LASTPAGE

const int iTextSharp.text.pdf.PdfAction.LASTPAGE = 4

static

A named action to go to the last page.

◆ NEXTPAGE

const int iTextSharp.text.pdf.PdfAction.NEXTPAGE = 3

static

A named action to go to the next page.

◆ PREVPAGE

const int iTextSharp.text.pdf.PdfAction.PREVPAGE = 2

static

A named action to go to the previous page.

◆ PRINTDIALOG

const int iTextSharp.text.pdf.PdfAction.PRINTDIALOG = 5

static

A named action to open a print dialog.

◆ RESET_EXCLUDE

const int iTextSharp.text.pdf.PdfAction.RESET_EXCLUDE = 1

static

a possible submitvalue

◆ SUBMIT_CANONICAL_FORMAT

const int iTextSharp.text.pdf.PdfAction.SUBMIT_CANONICAL_FORMAT = 512

static

a possible submitvalue

◆ SUBMIT_COORDINATES

const int iTextSharp.text.pdf.PdfAction.SUBMIT_COORDINATES = 16

static

◆ SUBMIT_EMBED_FORM

const int iTextSharp.text.pdf.PdfAction.SUBMIT_EMBED_FORM = 8196

static

a possible submitvalue

◆ SUBMIT_EXCL_F_KEY

const int iTextSharp.text.pdf.PdfAction.SUBMIT_EXCL_F_KEY = 2048

static

a possible submitvalue

◆ SUBMIT_EXCL_NON_USER_ANNOTS

const int iTextSharp.text.pdf.PdfAction.SUBMIT_EXCL_NON_USER_ANNOTS = 1024

static

a possible submitvalue

◆ SUBMIT_EXCLUDE

const int iTextSharp.text.pdf.PdfAction.SUBMIT_EXCLUDE = 1

static

◆ SUBMIT_HTML_FORMAT

const int iTextSharp.text.pdf.PdfAction.SUBMIT_HTML_FORMAT = 4

static

◆ SUBMIT_HTML_GET

const int iTextSharp.text.pdf.PdfAction.SUBMIT_HTML_GET = 8

static

◆ SUBMIT_INCLUDE_ANNOTATIONS

const int iTextSharp.text.pdf.PdfAction.SUBMIT_INCLUDE_ANNOTATIONS = 128

static

a possible submitvalue

◆ SUBMIT_INCLUDE_APPEND_SAVES

const int iTextSharp.text.pdf.PdfAction.SUBMIT_INCLUDE_APPEND_SAVES = 64

static

a possible submitvalue

◆ SUBMIT_INCLUDE_NO_VALUE_FIELDS

const int iTextSharp.text.pdf.PdfAction.SUBMIT_INCLUDE_NO_VALUE_FIELDS = 2

static

◆ SUBMIT_PDF

const int iTextSharp.text.pdf.PdfAction.SUBMIT_PDF = 256

static

a possible submitvalue

◆ SUBMIT_XFDF

const int iTextSharp.text.pdf.PdfAction.SUBMIT_XFDF = 32

static

a possible submitvalue

The documentation for this class was generated from the following file:

src/core/iTextSharp/text/pdf/PdfAction.cs

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfAction() [1/9]

◆ PdfAction() [2/9]

◆ PdfAction() [3/9]

◆ PdfAction() [4/9]

◆ PdfAction() [5/9]

◆ PdfAction() [6/9]

◆ PdfAction() [7/9]

◆ PdfAction() [8/9]

◆ PdfAction() [9/9]

Member Function Documentation

◆ CreateHide() [1/3]

◆ CreateHide() [2/3]

◆ CreateHide() [3/3]

◆ CreateImportData()

◆ CreateLaunch()

◆ CreateResetForm()

◆ CreateSubmitForm()

◆ GotoEmbedded() [1/2]

◆ GotoEmbedded() [2/2]

◆ GotoLocalPage() [1/2]

◆ GotoLocalPage() [2/2]

◆ GotoRemotePage()

◆ JavaScript() [1/2]

◆ JavaScript() [2/2]

◆ Next()

◆ Rendition()

◆ SetOCGstate()

Member Data Documentation

◆ FIRSTPAGE

◆ LASTPAGE

◆ NEXTPAGE

◆ PREVPAGE

◆ PRINTDIALOG

◆ 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