The Field Class
- class pypdf.generic.Field(data: DictionaryObject)[source]
Bases:
TreeObject
A class representing a field dictionary.
This class is accessed through
get_fields()
- indirect_reference: Optional[IndirectObject]
- property field_type: Optional[pypdf.generic._base.NameObject]
Read-only property accessing the type of this field.
- property fieldType: Optional[pypdf.generic._base.NameObject]
Use
field_type
instead.Deprecated since version 1.28.3.
- property parent: Optional[pypdf.generic._data_structures.DictionaryObject]
Read-only property accessing the parent of this field.
- property kids: Optional[pypdf.generic._data_structures.ArrayObject]
Read-only property accessing the kids of this field.
- property alternate_name: Optional[str]
Read-only property accessing the alternate name of this field.
- property altName: Optional[str]
Use
alternate_name
instead.Deprecated since version 1.28.3.
- 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 mappingName: Optional[str]
Use
mapping_name
instead.Deprecated since version 1.28.3.
- 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 defaultValue: Optional[Any]
Use
default_value
instead.Deprecated since version 1.28.3.
- property additional_actions: Optional[pypdf.generic._data_structures.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.
- property additionalActions: Optional[pypdf.generic._data_structures.DictionaryObject]
Use
additional_actions
instead.Deprecated since version 1.28.3.