Checkbox Widget

Places a group of checkboxes.

Remarks

Overview

The Checkbox Widget places one or more interactive checkboxes on the PDF, mapped from a Data Field with multiple values or options. Use this to visually represent multi-select fields, option lists, or OMR (optical mark recognition) results in exported PDF documents.

Configuration

• Add a Checkbox Widget annotation to the 'Annotations' collection of a PDF Data Mapping behavior.
• Use the 'Fields' property to specify which Data Fields or Data Columns the checkboxes should represent.
• Each checkbox is generated for a value or option present in the field's data.
• Configure 'Allow Edit' to control whether users can interact with the checkboxes in compatible PDF viewers.
• Set 'Print' to determine if the checkboxes appear in printed output.

Example Use Cases

• Represent a list of selected options (e.g., "Departments", "Services Provided") as checkboxes on the PDF.
• Display OMR results from scanned forms as checked or unchecked boxes.
• Allow end users to review and update selections directly in the PDF.

Notes

• Checkboxes are generated for each value or option present in the field's data.
• The appearance and interactivity of checkboxes may depend on the PDF viewer used.
• If the field contains no checkbox data, no annotation will be generated.

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.

See Also

Data FieldLogical Border