FieldData class

FieldData class

Represents field data such as a name, a page index, a field value, and possibly other types like text, image, or table.

The instances of FieldData class are used in DocumentData collection.

The FieldData type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of the FieldData class with UPPER CASE name.
init Initializes a new FieldData instance.
init Initializes a new instance of the FieldData class with UPPER CASE name.
init Initializes a new instance of the FieldData class.

Properties

Property Description
linked_field The linked field.
name The field name. An uppercase string value that represents the name of the field.
page_area The page area of the field.
page_index The zero-based index of the page that contains the field.
text The text of the field as a str; None if FieldData.page_area property isn’t a PageTextArea.
use_upper_case_name The boolean value indicates whether a Name was converted to UPPER CASE.

See Also