CIB pdf toolbox 2 technical documentation

4. Usecases

4.16. Formular fields


Property

Meaning

Type

FormEditor

FormEditor is a JSON-Object with commands, what should be done with PDF formfields. Currently only the command “Create” is supported.

The value of Create should be a JSON-Array of formfield definitions. A formfield definition has at least the keys “Type”, “Name” and “Annotation”:

  • Type: Can be:
    • Signature
    • Text
  • Name: the name of the new formfield.
  • Annotation: A JSON-array of rectangle definitions, where this formfield should be created on the page. E.g.: { "Rect": [300, 600, 200, 45], "Page" : 1 }

Additionally text fields can have the keys:

  • MaxLen: the max numbers of characters, which can be inserted.
  • Flags: A JSON-Array of combinable flags for this field:
    • Multiline
    • Password
    • Comb
    • ReadOnly
    • FileSelect
    • DoNotScroll
    • RichText 
  • Value: the content of the text field.

Set

NeedAppearences

A flag, which indicates, if NeedAppearences is active or not.

Get/Set

RegenerateFormFieldAppearences

A flag which indicates, that the formfield appearences should be regenerated from form field values.

Set