THotPDF Form Field Action Convenience Methods
Provide named wrappers for installing or clearing THPDFActionBuilder chains on AcroForm field and widget additional-action triggers
Declarations
procedure ClearFormFieldAdditionalAction(const FieldName: AnsiString; Trigger: THPDFFormFieldActionTrigger);
procedure SetFormFieldKeyStrokeAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldKeyStrokeAction(const FieldName: AnsiString);
procedure SetFormFieldFormatAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldFormatAction(const FieldName: AnsiString);
procedure SetFormFieldValidateAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldValidateAction(const FieldName: AnsiString);
procedure SetFormFieldCalculateAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldCalculateAction(const FieldName: AnsiString);
procedure SetFormFieldAnnotationAction(const FieldName: AnsiString; Trigger: THPDFAnnotationActionTrigger; Action: THPDFActionBuilder);
procedure ClearFormFieldAnnotationAction(const FieldName: AnsiString; Trigger: THPDFAnnotationActionTrigger);
procedure SetFormFieldMouseEnterAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldMouseEnterAction(const FieldName: AnsiString);
procedure SetFormFieldMouseExitAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldMouseExitAction(const FieldName: AnsiString);
procedure SetFormFieldMouseDownAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldMouseDownAction(const FieldName: AnsiString);
procedure SetFormFieldMouseUpAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldMouseUpAction(const FieldName: AnsiString);
procedure SetFormFieldSetFocusAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldSetFocusAction(const FieldName: AnsiString);
procedure SetFormFieldLostFocusAction(const FieldName: AnsiString; Action: THPDFActionBuilder);
procedure ClearFormFieldLostFocusAction(const FieldName: AnsiString);Unit
HPDFDoc
Trigger map
| Method family | PDF trigger | Purpose |
|---|---|---|
SetFormFieldKeyStrokeAction / ClearFormFieldKeyStrokeAction | /AA /K | Keystroke processing before a text value changes |
SetFormFieldFormatAction / ClearFormFieldFormatAction | /AA /F | Formatting after a field value changes |
SetFormFieldValidateAction / ClearFormFieldValidateAction | /AA /V | Validation before a value is committed |
SetFormFieldCalculateAction / ClearFormFieldCalculateAction | /AA /C | Calculation after dependent field changes |
SetFormFieldMouseEnterAction / ClearFormFieldMouseEnterAction | /AA /E | Widget pointer enters the annotation area |
SetFormFieldMouseExitAction / ClearFormFieldMouseExitAction | /AA /X | Widget pointer exits the annotation area |
SetFormFieldMouseDownAction / ClearFormFieldMouseDownAction | /AA /D | Mouse button is pressed inside the widget |
SetFormFieldMouseUpAction / ClearFormFieldMouseUpAction | /AA /U | Mouse button is released inside the widget |
SetFormFieldSetFocusAction / ClearFormFieldSetFocusAction | /AA /Fo | Widget receives input focus |
SetFormFieldLostFocusAction / ClearFormFieldLostFocusAction | /AA /Bl | Widget loses input focus |
Usage notes
- Call the set helpers after creating the target field and before
EndDoc - Each set helper replaces only the matching trigger entry and keeps the rest of the field or widget
/AAdictionary intact - Each clear helper removes only the matching trigger entry and deletes the empty
/AAdictionary when no entries remain - Use
SetFormFieldAdditionalActionandClearFormFieldAdditionalActionwhen code already works withTHPDFFormFieldActionTrigger - Use
SetFormFieldAnnotationActionandClearFormFieldAnnotationActionwhen code already works withTHPDFAnnotationActionTrigger - Builder validation still enforces PDF/A and PDF/X action restrictions before action dictionaries are written