Unofficial Content

PDFToolsFormField (Supporting External Object)

Objective

Name/value pair of an AcroForm form field, used by Query a form field and Query all form fields to return the result, and by Fill a form field and Fill all form fields to receive the value(s) to fill in.

Properties

Property Description
Key Name of the form field. In GetField, it is empty if the queried field does not exist in the document.
Value Current value of the field (GetField/GetFields) or value to write into the field (SetField/SetFields).
Options List of possible values the field accepts, comma-separated (see detail in Query a form field). Empty for text fields without a closed set of values. Populated by GetField/GetFields; ignored by SetField/SetFields.

Usage details

  • Building the collection for SetFields: the collection to pass can be built from scratch (adding Key/Value items one by one) or built from the result of Query all form fields and edited before passing it to Fill all form fields.

  • Using a single item for SetField: to fill a single specific field, a single item is passed (no collection needed) to Fill a form field.

  • The Options property is informational only: SetField/SetFields ignores it when writing the field's value.

Usage example

&PDFToolsStatus = &PDFToolsUtils.GetFields(&PDFFileSource,&PDFToolsFields)

for &Field in &PDFToolsFields
    // &Field.Key, &Field.Value, &Field.Options
endfor
Last update: 2026 | © GeneXus. All rights reserved. GeneXus Powered by Globant