Interface: ParsedPdfFormField

Form field metadata discovered while parsing an existing PDF.

Properties

Property	Modifier	Type	Description
buttonKind?	readonly	"checkBox" | "pushButton" | "radio"	Resolved button field subtype.
checked?	readonly	boolean	Initial checkbox checked state.
choiceMode?	readonly	"list" | "combo"	Resolved choice field display mode.
fieldType?	readonly	string	Raw AcroForm field type name.
multiline?	readonly	boolean	Whether the text field accepts multiple lines.
name	readonly	string	Name of the item, field, destination, or signer.
objectId	readonly	number	PDF indirect object number for the parsed item.
options?	readonly	readonly string[]	Options that control this item.
pageObjectId?	readonly	number	Object id of the page associated with this item.
readOnly?	readonly	boolean	Whether the form field is read-only.
rect?	readonly	readonly number[]	Annotation or widget rectangle in PDF coordinates.
required?	readonly	boolean	Whether the form field is required.
value?	readonly	string	Current or default value for the option.