Table of Contents

Class PdfAnnotationAdditionalActions

Namespace
iText.Kernel.Pdf.Action
Assembly
itext.kernel.dll

A wrapper for annotations additional actions dictionaries.

public class PdfAnnotationAdditionalActions : PdfObjectWrapper<PdfDictionary>
Inheritance
PdfAnnotationAdditionalActions
Inherited Members

Remarks

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

Constructors

PdfAnnotationAdditionalActions(PdfDictionary) 

public PdfAnnotationAdditionalActions(PdfDictionary pdfObject)

Parameters

pdfObject PdfDictionary

Methods

GetAllKnownActions()

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

public virtual IList<PdfAction> GetAllKnownActions()

Returns

IList<PdfAction>

The list of actions

Remarks

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

GetOnEnter()

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

public virtual PdfAction GetOnEnter()

Returns

PdfAction

PdfAction or null

GetOnExit()

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

public virtual PdfAction GetOnExit()

Returns

PdfAction

PdfAction or null

GetOnFocus()

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

public virtual PdfAction GetOnFocus()

Returns

PdfAction

PdfAction or null

GetOnLostFocus()

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

public virtual PdfAction GetOnLostFocus()

Returns

PdfAction

PdfAction or null

GetOnMouseDown()

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

public virtual PdfAction GetOnMouseDown()

Returns

PdfAction

PdfAction or null

GetOnMouseUp()

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

public virtual PdfAction GetOnMouseUp()

Returns

PdfAction

PdfAction or null

GetOnPageClosed()

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

public virtual PdfAction GetOnPageClosed()

Returns

PdfAction

PdfAction or null

GetOnPageLostView()

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

public virtual PdfAction GetOnPageLostView()

Returns

PdfAction

PdfAction or null

GetOnPageOpened()

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

public virtual PdfAction GetOnPageOpened()

Returns

PdfAction

PdfAction or null

GetOnPageVisible()

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

public virtual PdfAction GetOnPageVisible()

Returns

PdfAction

PdfAction or null

GetPdfActionForEvent(PdfName)

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

public virtual PdfAction GetPdfActionForEvent(PdfName eventName)

Parameters

eventName PdfName

The PdfName for the event.

Returns

PdfAction

the PdfAction or null

IsWrappedObjectMustBeIndirect() 

protected override bool IsWrappedObjectMustBeIndirect()

Returns

bool

SetOnEnter(PdfAction)

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

public virtual void SetOnEnter(PdfAction action)

Parameters

action PdfAction

The PdfAction to set or null to remove the action

SetOnExit(PdfAction)

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

public virtual void SetOnExit(PdfAction action)

Parameters

action PdfAction

PdfAction The action to set or null to remove the action

SetOnFocus(PdfAction)

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

public virtual void SetOnFocus(PdfAction action)

Parameters

action PdfAction

PdfAction The action to set or null to remove the action

SetOnLostFocus(PdfAction)

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

public virtual void SetOnLostFocus(PdfAction action)

Parameters

action PdfAction

PdfAction The action to set or null to remove the action

SetOnMouseDown(PdfAction)

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

public virtual void SetOnMouseDown(PdfAction action)

Parameters

action PdfAction

PdfAction The action to set or null to remove the action

SetOnMouseUp(PdfAction)

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

public virtual void SetOnMouseUp(PdfAction action)

Parameters

action PdfAction

PdfAction The action to set or null to remove the action

SetOnPageClosed(PdfAction)

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

public virtual void SetOnPageClosed(PdfAction action)

Parameters

action PdfAction

PdfAction The action to set or null to remove the action

SetOnPageLostView(PdfAction)

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

public virtual void SetOnPageLostView(PdfAction action)

Parameters

action PdfAction

PdfAction The action to set or null to remove the action

SetOnPageOpened(PdfAction)

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

public virtual void SetOnPageOpened(PdfAction action)

Parameters

action PdfAction

PdfAction The action to set or null to remove the action

SetOnPageVisible(PdfAction)

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

public virtual void SetOnPageVisible(PdfAction action)

Parameters

action PdfAction

PdfAction The action to set or null to remove the action

SetPdfActionForEvent(PdfName, PdfAction)

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

public virtual void SetPdfActionForEvent(PdfName @event, PdfAction action)

Parameters

event PdfName

the event to set or remove the action for

action PdfAction

the PdfAction to set or null