THPDFAnnotationActionTrigger Type
Selects the additional-action trigger event attached to an annotation through its /AA dictionary
Declaration
THPDFAnnotationActionTrigger= (aatMouseEnter, // /AA /E
aatMouseExit, // /AA /X
aatMouseDown, // /AA /D
aatMouseUp, // /AA /U
aatSetFocus, // /AA /Fo
aatLostFocus, // /AA /Bl
aatPageOpen, // /AA /PO
aatPageClose, // /AA /PC
aatPageVisible, // /AA /PV
aatPageInvisible); // /AA /PIUnit
HPDFDoc
Values
| Value | Meaning |
|---|---|
aatMouseEnter | /AA /E: the action runs when the cursor enters the annotation rectangle |
aatMouseExit | /AA /X: the action runs when the cursor leaves the annotation rectangle |
aatMouseDown | /AA /D: the action runs when a mouse button is pressed over the annotation |
aatMouseUp | /AA /U: the action runs when a mouse button is released on the annotation |
aatSetFocus | /AA /Fo: the action runs when the annotation receives input focus |
aatLostFocus | /AA /Bl: the action runs when the annotation loses input focus |
aatPageOpen | /AA /PO: the action runs when the page containing the annotation is opened |
aatPageClose | /AA /PC: the action runs when the page containing the annotation is closed |
aatPageVisible | /AA /PV: the action runs when the page containing the annotation becomes visible |
aatPageInvisible | /AA /PI: the action runs when the page containing the annotation becomes invisible |
Usage notes
- Pass a value of this type to THPDFPage.SetAnnotationAdditionalAction, THPDFAcroFormField.SetAnnotationAction or THotPDF.SetFormFieldAnnotationAction together with a THPDFActionBuilder
- The library maps each value to its PDF key (E, X, D, U, Fo, Bl, PO, PC, PV, PI); page-level triggers from aatPageOpen onward raise the minimum document version to PDF 1.5 whilst the mouse and focus triggers need PDF 1.2
- THotPDF.GetLoadedAnnotationActionChain returns the actions recorded per trigger on a loaded annotation and the Clear methods accept the same trigger value to remove one