Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Text Annotation

Field Annotation Grooper.Core

Places a PDF rectangle text annotation.

Remarks

Overview

The Text Annotation displays a text box at the location of a Data Field value. Use this to show extracted values, comments, or tooltips directly on the PDF for review, validation, or user guidance.

Configuration

  • Add a Text Annotation to the 'Annotations' collection of a PDF Data Mapping behavior.
  • Use the 'Fields' property to specify which Data Fields or Data Columns the annotation should apply to.
  • Set 'Fill Color' and 'Text Color' for the background and text appearance.
  • Set 'Font Name' and 'Font Size' to control the text style.
  • Configure 'Border Style', 'Border Color', and 'Border Width' for the outline of the annotation.
  • Use 'Transparency' to control the opacity of the background.
  • Adjust 'Allow Edit' to control whether users can interact with the annotation in compatible PDF viewers.
  • Set 'Print' to determine if the annotation appears in printed output.

Example Use Cases

  • Display the extracted invoice number in a yellow box with black text for easy identification.
  • Show reviewer comments or validation messages next to specific fields.
  • Provide tooltips or instructions for data entry fields in generated forms.

Notes

  • The annotation region is based on the detected location of the field's value on the PDF.
  • Use the 'Padding' property to expand or contract the annotation area.
  • The appearance and interactivity of text annotations may depend on the PDF viewer used.
  • If the field location is not detected, no annotation will be generated.

Properties

NameTypeDescription
General
Annotation Type String

The annotation type.

Appearance
Border

See Also

Notification