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

Highlight Annotation

Field Annotation Grooper.Core

Places a PDF rectangle highlight annotation.

Remarks

Overview

The Highlight Annotation visually highlights a region of the PDF corresponding to a Data Field value. Use this to draw attention to key data, such as totals, required fields, or other important information in exported PDF documents.

Configuration

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

Example Use Cases

  • Highlight the "Total Amount" field in green with a semi-transparent fill for easy review.
  • Emphasize required fields or missing information on forms.
  • Visually mark extracted values that need user attention or verification.

Notes

  • The highlight region is based on the detected location of the field's value on the PDF.
  • Adjust the 'Padding' property to expand or contract the highlighted area.
  • The appearance and interactivity of highlights 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

See Also

Notification