AnnotationActionCollection

Inheritance: java.lang.Object, com.aspose.pdf.BaseActionCollection

public final class AnnotationActionCollection extends BaseActionCollection

Represents the collection of annotation actions.

Methods

MethodDescription
getOnEnter()Gets an action to be performed when the cursor enters the annotation’s active area.
setOnEnter(PdfAction value)Sets an action to be performed when the cursor enters the annotation’s active area.
getOnExit()Gets an action to be performed when the cursor exits the annotation’s active area.
setOnExit(PdfAction value)Sets an action to be performed when the cursor exits the annotation’s active area.
getOnPressMouseBtn()Gets an action to be performed when the mouse button is pressed inside the annotation’s active area.
setOnPressMouseBtn(PdfAction value)Sets an action to be performed when the mouse button is pressed inside the annotation’s active area.
getOnReleaseMouseBtn()Gets an action to be performed when the mouse button is released inside the annotation’s active area.
setOnReleaseMouseBtn(PdfAction value)Sets an action to be performed when the mouse button is released inside the annotation’s active area.
getOnReceiveFocus()Gets an action to be performed when the annotation receives the input focus.
setOnReceiveFocus(PdfAction value)Sets an action to be performed when the annotation receives the input focus.
getOnOpenPage()Gets an action to be performed when the page containing the annotation is opened.
setOnOpenPage(PdfAction value)Sets an action to be performed when the page containing the annotation is opened.
getOnClosePage()Gets an action to be performed when the page containing the annotation is closed.
setOnClosePage(PdfAction value)Sets an action to be performed when the page containing the annotation is closed.
getOnShowPage()Get an action to be performed when the page containing the annotation becomes visible in the viewer application’s user interface.
setOnShowPage(PdfAction value)Sets an action to be performed when the page containing the annotation becomes visible in the viewer application’s user interface.
getOnHidePage()Gets an action to be performed when the page containing the annotation is no longer visible in the viewer application’s user interface.
setOnHidePage(PdfAction value)Sets an action to be performed when the page containing the annotation is no longer visible in the viewer application’s user interface.
getOnLostFocus()Gets an action to be performed when the annotation loses the input focus.
setOnLostFocus(PdfAction value)Sets an action to be performed when the annotation loses the input focus.
getOnModifyCharacter()Gets an action to be performed when user modifies character of the field.
setOnModifyCharacter(PdfAction value)Sets an action to be performed when user modifies character of the field.
getOnValidate()Gets an action to be performed when user changes contents of the field.
setOnValidate(PdfAction value)Sets an action to be performed when user changes contents of the field.
getOnFormat()Gets action to be performed to format field value.
setOnFormat(PdfAction value)Sets action to be performed to format field value.
getOnCalculate()Gets an action to calculate field value.
setOnCalculate(PdfAction value)Sets an action to calculate field value.

getOnEnter()

public PdfAction getOnEnter()

Gets an action to be performed when the cursor enters the annotation’s active area.

Returns: PdfAction - PdfAction object

setOnEnter(PdfAction value)

public void setOnEnter(PdfAction value)

Sets an action to be performed when the cursor enters the annotation’s active area.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnExit()

public PdfAction getOnExit()

Gets an action to be performed when the cursor exits the annotation’s active area.

Returns: PdfAction - PdfAction object

setOnExit(PdfAction value)

public void setOnExit(PdfAction value)

Sets an action to be performed when the cursor exits the annotation’s active area.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnPressMouseBtn()

public PdfAction getOnPressMouseBtn()

Gets an action to be performed when the mouse button is pressed inside the annotation’s active area.

Returns: PdfAction - PdfAction object

setOnPressMouseBtn(PdfAction value)

public void setOnPressMouseBtn(PdfAction value)

Sets an action to be performed when the mouse button is pressed inside the annotation’s active area.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnReleaseMouseBtn()

public PdfAction getOnReleaseMouseBtn()

Gets an action to be performed when the mouse button is released inside the annotation’s active area.

Returns: PdfAction - PdfAction object

setOnReleaseMouseBtn(PdfAction value)

public void setOnReleaseMouseBtn(PdfAction value)

Sets an action to be performed when the mouse button is released inside the annotation’s active area.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnReceiveFocus()

public PdfAction getOnReceiveFocus()

Gets an action to be performed when the annotation receives the input focus.

Returns: PdfAction - PdfAction object

setOnReceiveFocus(PdfAction value)

public void setOnReceiveFocus(PdfAction value)

Sets an action to be performed when the annotation receives the input focus.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnOpenPage()

public PdfAction getOnOpenPage()

Gets an action to be performed when the page containing the annotation is opened.

Returns: PdfAction - PdfAction object

setOnOpenPage(PdfAction value)

public void setOnOpenPage(PdfAction value)

Sets an action to be performed when the page containing the annotation is opened.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnClosePage()

public PdfAction getOnClosePage()

Gets an action to be performed when the page containing the annotation is closed.

Returns: PdfAction - PdfAction object

setOnClosePage(PdfAction value)

public void setOnClosePage(PdfAction value)

Sets an action to be performed when the page containing the annotation is closed.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnShowPage()

public PdfAction getOnShowPage()

Get an action to be performed when the page containing the annotation becomes visible in the viewer application’s user interface.

Returns: PdfAction - PdfAction object

setOnShowPage(PdfAction value)

public void setOnShowPage(PdfAction value)

Sets an action to be performed when the page containing the annotation becomes visible in the viewer application’s user interface.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnHidePage()

public PdfAction getOnHidePage()

Gets an action to be performed when the page containing the annotation is no longer visible in the viewer application’s user interface.

Returns: PdfAction - PdfAction object

setOnHidePage(PdfAction value)

public void setOnHidePage(PdfAction value)

Sets an action to be performed when the page containing the annotation is no longer visible in the viewer application’s user interface.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnLostFocus()

public PdfAction getOnLostFocus()

Gets an action to be performed when the annotation loses the input focus.

Returns: PdfAction - PdfAction object

setOnLostFocus(PdfAction value)

public void setOnLostFocus(PdfAction value)

Sets an action to be performed when the annotation loses the input focus.

Parameters:

ParameterTypeDescription
valuePdfActionPdfAction object

getOnModifyCharacter()

public PdfAction getOnModifyCharacter()

Gets an action to be performed when user modifies character of the field.

Returns: PdfAction - action to be performed when user modifies character of the field.

setOnModifyCharacter(PdfAction value)

public void setOnModifyCharacter(PdfAction value)

Sets an action to be performed when user modifies character of the field.

Parameters:

ParameterTypeDescription
valuePdfActionaction to be performed when user modifies character of the field.

getOnValidate()

public PdfAction getOnValidate()

Gets an action to be performed when user changes contents of the field.

Returns: PdfAction - action to be performed when user changes contents of the field.

setOnValidate(PdfAction value)

public void setOnValidate(PdfAction value)

Sets an action to be performed when user changes contents of the field.

Parameters:

ParameterTypeDescription
valuePdfActionaction to be performed when user changes contents of the field.

getOnFormat()

public PdfAction getOnFormat()

Gets action to be performed to format field value.

Returns: PdfAction - action to be performed to format field value.

setOnFormat(PdfAction value)

public void setOnFormat(PdfAction value)

Sets action to be performed to format field value.

Parameters:

ParameterTypeDescription
valuePdfActionaction to be performed to format field value.

getOnCalculate()

public PdfAction getOnCalculate()

Gets an action to calculate field value.

Returns: PdfAction - action to calculate field value.

setOnCalculate(PdfAction value)

public void setOnCalculate(PdfAction value)

Sets an action to calculate field value.

Parameters:

ParameterTypeDescription
valuePdfActionaction to calculate field value.