A wrapper for annotations additional actions dictionaries. More...

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

Public Member Functions
	PdfAnnotationAdditionalActions (PdfDictionary pdfObject)

virtual PdfAction	GetOnEnter ()
	Returns the PdfAction for the OnEnter event if there is any, or null. More...

virtual void	SetOnEnter (PdfAction action)
	Sets the PdfAction to perform on the OnEnter event, or removes it when action is null. More...

virtual PdfAction	GetOnExit ()
	Returns the PdfAction for the OnExit event if there is any, or null. More...

virtual void	SetOnExit (PdfAction action)
	Sets the PdfAction to perform on the OnExit event, or removes it when action is null. More...

virtual PdfAction	GetOnMouseDown ()
	Returns the PdfAction for the OnMouseDown event if there is any, or null. More...

virtual void	SetOnMouseDown (PdfAction action)
	Sets the PdfAction to perform on the OnMouseDown event, or removes it when action is null. More...

virtual PdfAction	GetOnMouseUp ()
	Returns the PdfAction for the OnMouseUp event if there is any, or null. More...

virtual void	SetOnMouseUp (PdfAction action)
	Sets the PdfAction to perform on the OnMouseUp event, or removes it when action is null. More...

virtual PdfAction	GetOnFocus ()
	Returns the PdfAction for the OnFocus event if there is any, or null. More...

virtual void	SetOnFocus (PdfAction action)
	Sets the PdfAction to perform on the OnFocus event, or removes it when action is null. More...

virtual PdfAction	GetOnLostFocus ()
	Returns the PdfAction for the OnLostFocus event if there is any, or null. More...

virtual void	SetOnLostFocus (PdfAction action)
	Sets the PdfAction to perform on the OnLostFocus event, or removes it when action is null. More...

virtual PdfAction	GetOnPageOpened ()
	Returns the PdfAction for the OnPageOpened event if there is any, or null. More...

virtual void	SetOnPageOpened (PdfAction action)
	Sets the PdfAction to perform on the OnPageOpened event, or removes it when action is null. More...

virtual PdfAction	GetOnPageClosed ()
	Returns the PdfAction for the OnPageClosed event if there is any, or null. More...

virtual void	SetOnPageClosed (PdfAction action)
	Sets the PdfAction to perform on the OnPageClosed event, or removes it when action is null. More...

virtual PdfAction	GetOnPageVisible ()
	Returns the PdfAction for the OnPageVisible event if there is any, or null. More...

virtual void	SetOnPageVisible (PdfAction action)
	Sets the PdfAction to perform on the OnPageVisible event, or removes it when action is null. More...

virtual PdfAction	GetOnPageLostView ()
	Returns the PdfAction for the OnPageLostView event if there is any, or null. More...

virtual void	SetOnPageLostView (PdfAction action)
	Sets the PdfAction to perform on the OnPageLostView event, or removes it when action is null. More...

virtual IList< PdfAction >	GetAllKnownActions ()
	Lists every PdfAction for all documented events for an annotation's additional actions. More...

virtual PdfAction	GetPdfActionForEvent (PdfName eventName)
	If exists, returns the PdfAction for this event, otherwise returns null. More...

virtual void	SetPdfActionForEvent (PdfName @event, PdfAction action)
	Sets the action for an event, or removes it when the action is null. 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 void	Flush ()

virtual bool	IsFlushed ()

Package Functions
override bool	IsWrappedObjectMustBeIndirect ()
	Defines if the object behind this wrapper must be an indirect object in the resultant document. More...

Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
	PdfObjectWrapper (T pdfObject)

virtual void	SetPdfObject (T pdfObject)

virtual void	SetForbidRelease ()

virtual void	UnsetForbidRelease ()

virtual void	EnsureUnderlyingObjectHasIndirectReference ()

Additional Inherited Members
Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
static void	MarkObjectAsIndirect (PdfObject pdfObject)

static void	EnsureObjectIsAddedToDocument (PdfObject @object)
	Some wrappers use object's indirect reference to obtain the `PdfDocument` to which the object belongs to. More...

Detailed Description

A wrapper for annotations additional actions dictionaries.

A wrapper for annotations additional actions dictionaries. See section 12.6.3 Table 197 of ISO 32000-1. An annotation additional actions dictionary defines the event handlers for annotations

Member Function Documentation

◆ GetAllKnownActions()

virtual IList<PdfAction> iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetAllKnownActions ( )

inlinevirtual

Lists every PdfAction for all documented events for an annotation's additional actions.

Lists every PdfAction for all documented events for an annotation's additional actions. See section 12.6.3 Table 197 of ISO 32000-1

Returns: The list of actions

◆ GetOnEnter()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnEnter ( )

inlinevirtual

Returns the PdfAction for the OnEnter event if there is any, or null.

Returns

PdfAction or null

◆ GetOnExit()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnExit ( )

inlinevirtual

Returns the PdfAction for the OnExit event if there is any, or null.

Returns

PdfAction or null

◆ GetOnFocus()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnFocus ( )

inlinevirtual

Returns the PdfAction for the OnFocus event if there is any, or null.

Returns

PdfAction or null

◆ GetOnLostFocus()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnLostFocus ( )

inlinevirtual

Returns the PdfAction for the OnLostFocus event if there is any, or null.

Returns

PdfAction or null

◆ GetOnMouseDown()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnMouseDown ( )

inlinevirtual

Returns the PdfAction for the OnMouseDown event if there is any, or null.

Returns

PdfAction or null

◆ GetOnMouseUp()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnMouseUp ( )

inlinevirtual

Returns the PdfAction for the OnMouseUp event if there is any, or null.

Returns

PdfAction or null

◆ GetOnPageClosed()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnPageClosed ( )

inlinevirtual

Returns the PdfAction for the OnPageClosed event if there is any, or null.

Returns

PdfAction or null

◆ GetOnPageLostView()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnPageLostView ( )

inlinevirtual

Returns the PdfAction for the OnPageLostView event if there is any, or null.

Returns

PdfAction or null

◆ GetOnPageOpened()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnPageOpened ( )

inlinevirtual

Returns the PdfAction for the OnPageOpened event if there is any, or null.

Returns

PdfAction or null

◆ GetOnPageVisible()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetOnPageVisible ( )

inlinevirtual

Returns the PdfAction for the OnPageVisible event if there is any, or null.

Returns

PdfAction or null

◆ GetPdfActionForEvent()

virtual PdfAction iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.GetPdfActionForEvent ( PdfName eventName )

inlinevirtual

If exists, returns the PdfAction for this event, otherwise returns null.

Parameters

eventName The iText.Kernel.Pdf.PdfName for the event.

Returns: the PdfAction or null

◆ IsWrappedObjectMustBeIndirect()

override bool iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.IsWrappedObjectMustBeIndirect ( )

inlinepackagevirtual

Defines if the object behind this wrapper must be an indirect object in the resultant document.

Implements iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.

◆ SetOnEnter()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnEnter ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnEnter event, or removes it when action is null.

Parameters

action The PdfAction to set or null to remove the action

◆ SetOnExit()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnExit ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnExit event, or removes it when action is null.

Parameters

action

PdfAction The action to set or null to remove the action

◆ SetOnFocus()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnFocus ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnFocus event, or removes it when action is null.

Parameters

action

PdfAction The action to set or null to remove the action

◆ SetOnLostFocus()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnLostFocus ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnLostFocus event, or removes it when action is null.

Parameters

action

PdfAction The action to set or null to remove the action

◆ SetOnMouseDown()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnMouseDown ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnMouseDown event, or removes it when action is null.

Parameters

action

PdfAction The action to set or null to remove the action

◆ SetOnMouseUp()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnMouseUp ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnMouseUp event, or removes it when action is null.

Parameters

action

PdfAction The action to set or null to remove the action

◆ SetOnPageClosed()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnPageClosed ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnPageClosed event, or removes it when action is null.

Parameters

action

PdfAction The action to set or null to remove the action

◆ SetOnPageLostView()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnPageLostView ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnPageLostView event, or removes it when action is null.

Parameters

action

PdfAction The action to set or null to remove the action

◆ SetOnPageOpened()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnPageOpened ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnPageOpened event, or removes it when action is null.

Parameters

action

PdfAction The action to set or null to remove the action

◆ SetOnPageVisible()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetOnPageVisible ( PdfAction action )

inlinevirtual

Sets the PdfAction to perform on the OnPageVisible event, or removes it when action is null.

Parameters

action

PdfAction The action to set or null to remove the action

◆ SetPdfActionForEvent()

virtual void iText.Kernel.Pdf.Action.PdfAnnotationAdditionalActions.SetPdfActionForEvent	(	PdfName @	event,
		PdfAction	action
	)

inlinevirtual

Sets the action for an event, or removes it when the action is null.

Parameters

event	the event to set or remove the action for
action	the PdfAction to set or null

Public Member Functions

Package Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetAllKnownActions()

◆ GetOnEnter()

◆ GetOnExit()

◆ GetOnFocus()

◆ GetOnLostFocus()

◆ GetOnMouseDown()

◆ GetOnMouseUp()

◆ GetOnPageClosed()

◆ GetOnPageLostView()

◆ GetOnPageOpened()

◆ GetOnPageVisible()

◆ GetPdfActionForEvent()

◆ IsWrappedObjectMustBeIndirect()

◆ SetOnEnter()

◆ SetOnExit()

◆ SetOnFocus()

◆ SetOnLostFocus()

◆ SetOnMouseDown()

◆ SetOnMouseUp()

◆ SetOnPageClosed()

◆ SetOnPageLostView()

◆ SetOnPageOpened()

◆ SetOnPageVisible()

◆ SetPdfActionForEvent()