PdfFormField class

A form field extracted from a PDF's AcroForm or XFA structure.

Populated by the PDF extractor when PdfConfig::extract_form_fields is enabled and the document is a fillable form. Supports both AcroForm (standard) and XFA (XML Forms Architecture) layers. When both are present, AcroForm fields take priority (canonical fallback per PDF spec), and XFA-only fields are appended. The collection is empty for non-form PDFs and for non-PDF formats.

Constructors

PdfFormField({required String name, required String fullName, required FormFieldType fieldType, String? value, String? defaultValue, required PlatformInt64 flags, PlatformInt64? page, BoundingBox? bbox, PlatformInt64? maxLength, String? tooltip})
const

Properties

bbox → BoundingBox?
Widget bounding box on its page, if known.
final
defaultValue → String?
Default field value, if any.
final
fieldType → FormFieldType
Classified field type.
final
flags → int
Raw field-flags bitmask (read-only, required, multiline, …).
final
fullName → String
Fully-qualified field name (dotted path from the form root).
final
hashCode → int
The hash code for this object.
no setteroverride
maxLength → PlatformInt64?
Maximum input length for text fields, if specified.
final
name → String
Partial field name (the leaf name within the field hierarchy).
final
page → PlatformInt64?
1-indexed page the field's widget appears on. Currently always None for AcroForm fields; page assignment is a deferred enhancement requiring spatial analysis of widget annotations per page.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tooltip → String?
Tooltip / alternate field description, if present.
final
value → String?
Current field value, if any.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override