Appearance
zeropdf / ParsedPdfFormField
Interface: ParsedPdfFormField
Defined in: src/parser.ts:244
Form field metadata discovered while parsing an existing PDF.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
buttonKind? | readonly | "checkBox" | "pushButton" | "radio" | Resolved button field subtype. | src/parser.ts:252 |
checked? | readonly | boolean | Initial checkbox checked state. | src/parser.ts:260 |
choiceMode? | readonly | "list" | "combo" | Resolved choice field display mode. | src/parser.ts:258 |
fieldType? | readonly | string | Raw AcroForm field type name. | src/parser.ts:250 |
multiline? | readonly | boolean | Whether the text field accepts multiple lines. | src/parser.ts:270 |
name | readonly | string | Name of the item, field, destination, or signer. | src/parser.ts:248 |
objectId | readonly | number | PDF indirect object number for the parsed item. | src/parser.ts:246 |
options? | readonly | readonly string[] | Options that control this item. | src/parser.ts:256 |
pageObjectId? | readonly | number | Object id of the page associated with this item. | src/parser.ts:262 |
readOnly? | readonly | boolean | Whether the form field is read-only. | src/parser.ts:266 |
rect? | readonly | readonly number[] | Annotation or widget rectangle in PDF coordinates. | src/parser.ts:264 |
required? | readonly | boolean | Whether the form field is required. | src/parser.ts:268 |
value? | readonly | string | Current or default value for the option. | src/parser.ts:254 |