Field Enumerations

  • Undocumented

    See more



    enum PTFieldActionTriggerEvent
    e_ptaction_trigger_keystroke = 13, //Triggered when user modifies text, or selection, in a text, combo or list field
    e_ptaction_trigger_format = 14, //Triggered before a field value is displayed.
    e_ptaction_trigger_validate = 15, //Triggered when a field value is changed
    e_ptaction_trigger_calculate = 16 //Triggered when field is recalculated due to a change in another field


    struct PTFieldActionTriggerEvent : Equatable, RawRepresentable
  • PTFieldFlags specifying various characteristics of the fields.

    Field flags common to all field types:

    • If e_ptread_only flag is set the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.

    • If e_ptrequired flag is set, the field must have a value at the time it is exported by a submit-form action.

    • If e_ptno_export flag is set, the field must not be exported by a submit-form action.

    Field flags specific to radio buttons:

    • If e_pttoggle_to_off is clear, exactly one radio button must be selected at all times; clicking the currently selected button has no effect. If set, clicking the selected button deselects it, leaving no button selected.

    • If e_ptradios_in_unison is set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

    Field flags specific to text fields:

    • If e_ptmultiline is set, the field can contain multiple lines of text; if clear, the field’s text is restricted to a single line.

    • If e_ptpassword If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters. The value is not stored if this flag is set.

    • If e_ptfile_select is set, the text entered in the field represents the pathname of a file whose contents are to be submitted as the value of the field.

    • If e_ptno_spellcheck is set, text entered in the field is not spell-checked.

    • If e_ptno_scroll is set, the field does not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text is accepted.

    • If e_ptcomb is set, the field is automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs. Meaningful only if the MaxLen entry is present in the text field and if the Multiline, Password, and FileSelect flags are clear.

    • If e_ptrich_text is set, the value of this field should be represented as a rich text string. If the field has a value, the RV entry of the field dictionary specifies the rich text string.

    Field flags specific to choice fields:

    • If e_ptcombo is set, the field is a combo box; if clear, the field is a list box.

    • If e_ptedit is set, the combo box includes an editable text box as well as a dropdown list; if clear, it includes only a drop-down list. This flag is meaningful only if the e_ptcombo flag is set.

    • If e_ptsort is set, the field’s option items should be sorted alphabetically. This flag is intended for use by form authoring tools, not by PDF viewer applications. Viewers should simply display the options in the order in which they occur in the Opt array.

    • If e_ptmultiselect is set, more than one of the field’s option items may be selected simultaneously; if clear, no more than one item at a time may be selected.

    • If e_ptcommit_on_sel_change is set, the new value is committed as soon as a selection is made with the pointing device. This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If clear, the new value is not committed until the user exits the field.

    See more



    enum PTFieldFlag {}


    struct PTFieldFlag : Equatable, RawRepresentable
  • Interactive forms support the following field types:

    • Button fields represent interactive controls on the screen that the user can manipulate with the mouse. They include pushbuttons, check-boxes, and radio buttons.
    • Text fields are boxes or spaces in which the user can enter text from the keyboard.
    • Choice fields contain several text items, at most one of which may be selected as the field value. They include scrollable list boxes and combo boxes.
    • Signature fields represent electronic ‘signatures’ for authenticating the identity of a user and the validity of the document’s contents.
    See more



    enum PTFieldType {}


    struct PTFieldType : Equatable, RawRepresentable