THotPDF Form Field Action Convenience Methods

Method summary: THotPDF Form Field Action Convenience MethodsTHPDFActionBuilder 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 /KKeystroke processing before a text value changes`/AA /K`	/AA /FFormatting after a field value changes
`SetFormFieldValidateAction` / `ClearFormFieldValidateAction`	/AA /VValidation before a value is committed`/AA /F`	/AA /CCalculation after dependent field changes
`SetFormFieldMouseEnterAction` / `ClearFormFieldMouseEnterAction`	/AA /EWidget pointer enters the annotation area`/AA /V`	/AA /XWidget pointer exits the annotation area
`SetFormFieldMouseDownAction` / `ClearFormFieldMouseDownAction`	/AA /DMouse button is pressed inside the widget`/AA /C`	/AA /UMouse button is released inside the widget
`SetFormFieldSetFocusAction` / `ClearFormFieldSetFocusAction`	/AA /FoWidget receives input focus`/AA /E`	Widget pointer enters the annotation area
`SetFormFieldLostFocusAction` / `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`	/AA /BlWidget loses input focus

Usage notes

Call the set helpers after creating the target field and before EndDocEndDoc
Each set helper replaces only the matching trigger entry and keeps the rest of the field or widget /AA dictionary intact/AA dictionary intact
Each clear helper removes only the matching trigger entry and deletes the empty /AA dictionary when no entries remain/AA dictionary when no entries remain
Use SetFormFieldAdditionalAction and ClearFormFieldAdditionalAction when code already works with THPDFFormFieldActionTriggerSetFormFieldAdditionalAction and ClearFormFieldAdditionalAction when code already works with THPDFFormFieldActionTrigger
Use SetFormFieldAnnotationAction and ClearFormFieldAnnotationAction when code already works with THPDFAnnotationActionTriggerSetFormFieldAnnotationAction and ClearFormFieldAnnotationAction when code already works with THPDFAnnotationActionTrigger
Builder validation still enforces PDF/A and PDF/X action restrictions before action dictionaries are written

Related API

THotPDFSetFormFieldAdditionalActionMethod
THPDFPageSetAnnotationAdditionalActionMethod
THPDFPageClearAnnotationAdditionalActionMethod
THPDFActionBuilderClass
AcroFormSupport