PdfFormField class
One terminal field of the form: a value plus the widget annotations that display it on pages.
Properties
- appearanceColor → int?
-
The /DA text colour as 0xRRGGBB, or null when the /DA sets none (the
appearance then defaults to black). Reads the last
g/rg/kcolour-setting operator and its operands (§12.7.3.3).no setter - appearanceFontSize → double
-
The /DA font size in points; 0 means auto-size (the appearance fits
the text to the box). Parsed from the
/Font size Tfoperator.no setter - defaultAppearance → String?
-
The field's /DA string, falling back to the form-wide default.
no setter
- dict → CosDictionary
-
The raw field dictionary (also the widget dictionary when merged).
final
- fieldTypeName → String?
-
The /FT name without the slash ('Tx', 'Btn', 'Ch', 'Sig'), inherited.
no setter
- flags → int
-
The /Ff field-flag word, inherited.
no setter
- form → PdfAcroForm
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isChecked → bool
-
Whether a check box or radio group is on (/V set and not /Off).
no setter
- isMultiline → bool
-
no setter
- isPassword → bool
-
no setter
- isReadOnly → bool
-
no setter
- isRequired → bool
-
no setter
- name → String
-
Fully qualified name: partial /T names joined with dots.
final
-
onStates
→ List<
String> -
The on-state names a button's widgets define: the keys of each
/AP /N state dictionary except 'Off'. A plain check box has one
(conventionally 'Yes'); a radio group has one per button.
no setter
-
options
→ List<
(String, String)> -
Choice options as (exportValue, displayValue) pairs. /Opt entries are
either plain strings or
export displaypairs (§12.7.5.4).no setter - quadding → int
-
/Q quadding: 0 left (default), 1 centered, 2 right.
no setter
-
reconciledWidgets
→ List<
CosDictionary> -
The widgets this field adopted from outside /Fields during
reconciliation (empty for well-formed fields). The field dictionary
drives their appearance; a filler clears their stale /V so the
canonical field value wins.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → PdfFieldType
-
no setter
- value → String?
-
The current value as text: /V strings come back verbatim, button
state names without the slash, multi-select arrays as their first
string. Null when the field is empty.
no setter
-
widgets
→ List<
CosDictionary> -
The widget annotations displaying this field: the on-page copies
adopted by reconciliation when present, otherwise its /Kids without a
/T of their own, or the field dictionary itself when merged.
no setter
Methods
-
inherited(
String key) → CosObject? - Resolves an inheritable entry up the /Parent chain (§12.7.4.2).
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
widgetOnState(
int index) → String? -
The on-state name widget
indexdefines: the first key of its /AP /N state dictionary that isn't 'Off'. For a radio group this is the state tapping that particular button selects; null for widgets without state appearances (or an out-of-rangeindex). -
widgetPageIndex(
int index) → int -
The page index displaying widget
index: the widget's /P entry when it resolves to a page, otherwise the first page whose /Annots array lists the widget. −1 when no page claims it. -
widgetRect(
int index) → PdfRect? -
The rectangle of widget
indexin page space, or null when the widget is malformed.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- comboFlag → const int
- editFlag → const int
- multilineFlag → const int
- passwordFlag → const int
- pushButtonFlag → const int
- radioFlag → const int
- readOnlyFlag → const int
- requiredFlag → const int