The Field Class

class pypdf.generic.Field(data: DictionaryObject)[source]

A class representing a field dictionary.

This class is accessed through get_fields()

property field_type: Optional[NameObject]: Read-only property accessing the type of this field.

property parent: Optional[DictionaryObject]: Read-only property accessing the parent of this field.

property kids: Optional[ArrayObject]: Read-only property accessing the kids of this field.

property name: Optional[str]: Read-only property accessing the name of this field.

property alternate_name: Optional[str]: Read-only property accessing the alternate name of this field.

property mapping_name: Optional[str]

Read-only property accessing the mapping name of this field.

This name is used by pypdf as a key in the dictionary returned by get_fields()

property flags: Optional[int]: Read-only property accessing the field flags, specifying various characteristics of the field (see Table 8.70 of the PDF 1.7 reference).

property value: Optional[Any]

Read-only property accessing the value of this field.

Format varies based on field type.

property default_value: Optional[Any]: Read-only property accessing the default value of this field.

property additional_actions: Optional[DictionaryObject]

Read-only property accessing the additional actions dictionary.

This dictionary defines the field’s behavior in response to trigger events. See Section 8.5.2 of the PDF 1.7 reference.