Skip to content

zeropdf v1.3.0


zeropdf / ParsedPdfFormField

Interface: ParsedPdfFormField

Defined in: src/parser.ts:244

Form field metadata discovered while parsing an existing PDF.

Properties

PropertyModifierTypeDescriptionDefined in
buttonKind?readonly"checkBox" | "pushButton" | "radio"Resolved button field subtype.src/parser.ts:252
checked?readonlybooleanInitial checkbox checked state.src/parser.ts:260
choiceMode?readonly"list" | "combo"Resolved choice field display mode.src/parser.ts:258
fieldType?readonlystringRaw AcroForm field type name.src/parser.ts:250
multiline?readonlybooleanWhether the text field accepts multiple lines.src/parser.ts:270
namereadonlystringName of the item, field, destination, or signer.src/parser.ts:248
objectIdreadonlynumberPDF indirect object number for the parsed item.src/parser.ts:246
options?readonlyreadonly string[]Options that control this item.src/parser.ts:256
pageObjectId?readonlynumberObject id of the page associated with this item.src/parser.ts:262
readOnly?readonlybooleanWhether the form field is read-only.src/parser.ts:266
rect?readonlyreadonly number[]Annotation or widget rectangle in PDF coordinates.src/parser.ts:264
required?readonlybooleanWhether the form field is required.src/parser.ts:268
value?readonlystringCurrent or default value for the option.src/parser.ts:254

Released under the ISC license.