pdfrx_web
    Preparing search index...

    Interface PdfFormField

    An AcroForm field of a document. A field is identified by its fully-qualified name; widgets that share a name (e.g. the buttons of a radio group) are merged into one field with several rects. Obtain them via PdfPage.loadFormFields / PdfDocument.loadFormFields, read values here, and change them with PdfDocument.setFormFieldValue.

    Field dictionaries and fully-qualified field names are specified by ISO 32000-2:2020, 12.7.4, especially Tables 226 and 227. Type-specific entries are specified by 12.7.5.

    interface PdfFormField {
        alternateName: string | null;
        exportValue?: string | null;
        flags: PdfFormFieldFlags;
        isChecked?: boolean;
        multiline?: boolean;
        name: string;
        options?: readonly PdfFormFieldOption[];
        pageNumber: number;
        rects: readonly PdfRect[];
        textOrientations: readonly PdfTextOrientation[];
        type: PdfFormFieldType;
        value: string;
    }
    Index
    alternateName exportValue? flags isChecked? multiline? name options? pageNumber rects textOrientations type value
    alternateName: string | null

    Alternate name / tooltip (/TU), or null.

    exportValue?: string | null

    Checkbox/radio: the export ("on") value; for a radio group, the selected one.

    flags: PdfFormFieldFlags

    Decoded field flags.

    isChecked?: boolean

    Checkbox/radio: whether the field is currently checked/selected.

    multiline?: boolean

    Text fields: whether the field accepts multiple lines (/Ff Multiline bit).

    name: string

    Fully-qualified field name (/T); may be empty for unnamed fields.

    options?: readonly PdfFormFieldOption[]

    Combo/list: the options and their selection state.

    pageNumber: number

    1-based page number the field's widget(s) sit on.

    rects: readonly PdfRect[]

    Widget rectangles in PDF page coordinates (one per widget).

    textOrientations: readonly PdfTextOrientation[]

    Text orientation for each widget, parallel to rects.

    type: PdfFormFieldType

    Field kind.

    value: string

    Current value (/V): the text, the selected export value, or '' for buttons.

    Settings
    Member Visibility

    On This Page
    Properties