Field Annotation

A base class for annotations to be applied when exporting PDFs.

Remarks

Overview

The Field Annotation class defines the base configuration for adding visual or interactive elements to exported PDF documents. Each annotation is mapped to one or more Data Fields or Data Columns, and can be customized for appearance, interactivity, and print behavior.

Usage

• Add one or more Field Annotations to the 'Annotations' property of a PDF Data Mapping behavior.
• Use the 'Fields' property to specify which Data Fields or Data Columns the annotation applies to. If left empty, the annotation applies to all single-instance fields.
• Configure properties such as 'Padding', 'Allow Edit', and 'Print' to control the annotation's behavior and visibility.

Example Scenarios

• Highlight extracted values for key fields.
• Add interactive widgets (textboxes, checkboxes, signatures) for data entry or review.
• Visually indicate required or reviewed fields.

Notes

• Annotations are generated for each instance of the specified Data Fields that have a valid location on the page.
• The order of annotations determines their layering on the PDF.
• Subclasses define specific annotation types and additional properties.

Properties

Name	Type		Description
Annotation Type	String		The annotation type.
Fields	Data Field[]	►	The list of fields to generate annotations for. EditorField Annotation Editor ConverterAll Fields Converter Selects which Data Fields or Data Columns this annotation applies to. Add one or more fields to target specific data elements. If left empty, the annotation will apply to all single-instance fields in the Document Type. Use this to visually highlight, annotate, or add widgets to specific fields.
Padding	Logical Border	►	The amount of padding to include around each zone. ConverterLogical Border Converter Positive values increase the size of the annotation; negative values decrease it. Use to adjust the visual region of the annotation relative to the field's detected location. Useful for emphasizing or de-emphasizing the annotated area.
Allow Edit	Boolean	►	Specifies whether the annotation should be editable in PDF viewer applications. DefaultFalse When enabled, users can interact with or modify the annotation in compatible PDF viewers. Applies to interactive widgets and some visual annotations.
Print	Boolean	►	Specifies whether the annotation should be included when the PDF document is printed. DefaultFalse Enable to ensure the annotation appears in printed output. Disable to make the annotation visible only on-screen.

Derived Types

There are 6 implementations of Field Annotation.

Checkbox Widget	Places a group of checkboxes.
Highlight Annotation	Places a PDF rectangle highlight annotation.
Radio Group Widget	Places a group of radio buttons.
Signature Widget	Places a PDF signature widget.
Text Annotation	Places a PDF rectangle text annotation.
Textbox Widget	Places a PDF textbox field.

See Also

Data FieldLogical Border

Used By

PDF Data Mapping